projects / github / Chocobozzz / PeerTube.git / blame
| 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> | |
| 267 | </nav> | |
| 268 | </div> | |
| 269 | <div id="docs" class="row collapse expanded drawer" data-drawer> | |
| 270 | <button class="floating-menu-icon" type="button" data-drawer-slide="right"> | |
| 271 | <span class="hamburger"></span> | |
| 272 | </button> | |
| 273 | <div class="example-box doc-content"></div> | |
| 274 | <article> | |
| 228e84aa C |
275 | <h1 class="doc-title">PeerTube |
| 276 | <span>API Reference</span> | |
| 277 | </h1> | |
| 5e1c08eb | 278 | <div id="introduction" data-traverse-target="introduction"> |
| 5e1c08eb C |
279 | <div class="doc-row"> |
| 280 | <div class="doc-copy"> | |
| 281 | <p>Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.</p> | |
| 282 | </div> | |
| 283 | <div class="doc-examples"> | |
| 284 | <section> | |
| ea65a476 C |
285 | <h5>API Endpoint</h5> |
| 286 | <!-- <div class="hljs"> --><pre><code>https://peertube.example.com/api/v1</code></pre> | |
| 287 | <!-- </div> --> | |
| 288 | <h5>Schemes: | |
| 289 | <span>https</span> | |
| 290 | </h5> | |
| 5e1c08eb | 291 | <h5>Version: |
| 164e6c87 | 292 | <span>1.0.0-beta</span> |
| 5e1c08eb C |
293 | </h5> |
| 294 | </section> | |
| 295 | </div> | |
| 296 | </div> | |
| 297 | </div> | |
| 94ff4c23 C |
298 | <!-- <h1 id="security" data-traverse-target="security">Security</h1> --> |
| 299 | <h1 id="authentication" data-traverse-target="authentication">Authentication</h1> | |
| 300 | <div id="security-definition-OAuth2" class="panel"> | |
| 301 | <div class="doc-row"> | |
| 302 | <div class="doc-copy"> | |
| 303 | <h3 class="security-definition-title"> | |
| 304 | <span class="security-name">OAuth2</span> | |
| 305 | <span class="swagger-security-definition-oauth2"></span> | |
| 306 | </h3> | |
| 307 | <section class="security-definition-description"> | |
| 308 | <p>In the header: | |
| 309 | <em>Authorization: Bearer mytoken</em> | |
| 310 | </p> | |
| 311 | </section> | |
| 312 | <section class="swagger-security-definition-properties"> | |
| 313 | <div class="prop-row security-definition-property"> | |
| 314 | <div class="prop-name"> | |
| 315 | <div class="prop-title security-definition-property-name">type</div> | |
| 316 | </div> | |
| 317 | <div class="prop-value security-definition-property-type"> oauth2 </div> | |
| 318 | </div> | |
| 319 | <div class="prop-row security-definition-property"> | |
| 320 | <div class="prop-name"> | |
| 321 | <div class="prop-title security-definition-property-name">flow</div> | |
| 322 | </div> | |
| 323 | <div class="prop-value security-definition-property-type"> password </div> | |
| 324 | </div> | |
| 325 | <div class="prop-row security-definition-property"> | |
| 326 | <div class="prop-name"> | |
| 327 | <div class="prop-title security-definition-property-name">tokenUrl</div> | |
| 328 | </div> | |
| 329 | <div class="prop-value security-definition-property-type"> https://peertube.example.com/api/v1/users/token </div> | |
| 330 | </div> | |
| 331 | </section> | |
| 332 | </div> | |
| 333 | </div> | |
| 334 | </div> | |
| 5e1c08eb | 335 | <h1 id="tag-Accounts" class="swagger-summary-tag" data-traverse-target="tag-Accounts">Accounts</h1> |
| ad9e39fb | 336 | <div id="operation--accounts--name--get" class="operation panel" data-traverse-target="operation--accounts--name--get"> |
| 5e1c08eb C |
337 | <!-- <section class="operation-tags row"> --> |
| 338 | <!-- <div class="doc-copy"> --> | |
| 339 | <div class="operation-tags"> | |
| 340 | <a class="label" href="#tag-Accounts">Accounts</a> | |
| 341 | <!----> | |
| 342 | </div> | |
| 343 | <!-- </div> --> | |
| 344 | <!-- </section> --> | |
| 345 | <h2 class="operation-title"> | |
| 346 | <span class="operation-name"> | |
| 347 | <span class="operation-name">GET</span> | |
| ad9e39fb | 348 | <span class="operation-path">/accounts/{name}</span> |
| 5e1c08eb C |
349 | </span> |
| 350 | </h2> | |
| 351 | <div class="doc-row"> | |
| 352 | <div class="doc-copy"> | |
| 353 | <section class="swagger-request-params"> | |
| 354 | <div class="prop-row prop-group"> | |
| 355 | <div class="prop-name"> | |
| ad9e39fb | 356 | <div class="prop-title">name</div> |
| 5e1c08eb | 357 | <span class="json-property-required"></span> |
| 228e84aa C |
358 | <div class="prop-subtitle"> in path </div> |
| 359 | <div class="prop-subtitle"> | |
| 360 | <span class="json-property-type">string</span> | |
| 361 | <span class="json-property-range" title="Value limits"></span> | |
| 362 | </div> | |
| 5e1c08eb C |
363 | </div> |
| 364 | <div class="prop-value"> | |
| ad9e39fb C |
365 | <p>The name of the account (chocobozzz or |
| 366 | <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p> | |
| 5e1c08eb C |
367 | </div> |
| 368 | </div> | |
| ab0ee6a1 C |
369 | <div class="prop-row prop-group"> |
| 370 | <div class="prop-name"> | |
| 371 | <div class="prop-title">start</div> | |
| 228e84aa C |
372 | <div class="prop-subtitle"> in query </div> |
| 373 | <div class="prop-subtitle"> | |
| 374 | <span class="json-property-type">number</span> | |
| 375 | <span class="json-property-range" title="Value limits"></span> | |
| 376 | </div> | |
| ab0ee6a1 C |
377 | </div> |
| 378 | <div class="prop-value"> | |
| 379 | <p>starting page</p> | |
| 380 | </div> | |
| 381 | </div> | |
| ab0ee6a1 C |
382 | <div class="prop-row prop-group"> |
| 383 | <div class="prop-name"> | |
| 384 | <div class="prop-title">stop</div> | |
| 228e84aa C |
385 | <div class="prop-subtitle"> in query </div> |
| 386 | <div class="prop-subtitle"> | |
| 387 | <span class="json-property-type">number</span> | |
| 388 | <span class="json-property-range" title="Value limits"></span> | |
| 389 | </div> | |
| ab0ee6a1 C |
390 | </div> |
| 391 | <div class="prop-value"> | |
| f209b32a | 392 | <p>stopping page</p> |
| ab0ee6a1 C |
393 | </div> |
| 394 | </div> | |
| ab0ee6a1 C |
395 | <div class="prop-row prop-group"> |
| 396 | <div class="prop-name"> | |
| 397 | <div class="prop-title">sort</div> | |
| 228e84aa C |
398 | <div class="prop-subtitle"> in query </div> |
| 399 | <div class="prop-subtitle"> | |
| 400 | <span class="json-property-type">number</span> | |
| 401 | <span class="json-property-range" title="Value limits"></span> | |
| 402 | </div> | |
| ab0ee6a1 C |
403 | </div> |
| 404 | <div class="prop-value"> | |
| 405 | <p>sorting</p> | |
| 406 | </div> | |
| 407 | </div> | |
| 5e1c08eb C |
408 | </section> |
| 409 | </div> | |
| 410 | <div class="doc-examples"></div> | |
| 411 | </div> | |
| 412 | <div class="doc-row"> | |
| 413 | <div class="doc-copy"> | |
| 414 | <section class="swagger-responses"> | |
| 415 | <div class="prop-row prop-group"> | |
| 416 | <div class="prop-name"> | |
| 417 | <div class="prop-title">200 OK</div> | |
| 418 | <div class="prop-ref"> | |
| 419 | <span class=""> | |
| 420 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
| 421 | </span> | |
| 422 | </div> | |
| 423 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 424 | </div> | |
| 425 | <div class="prop-value"> | |
| 426 | <p>successful operation</p> | |
| 427 | </div> | |
| 428 | </div> | |
| 429 | </section> | |
| 430 | </div> | |
| 431 | <div class="doc-examples"> | |
| 432 | <h5>Response Content-Types: | |
| 433 | <span>application/json</span> | |
| 434 | </h5> | |
| 435 | <section> | |
| 436 | <h5>Response Example | |
| 437 | <span>(200 OK)</span> | |
| 438 | </h5> | |
| 439 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 440 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 441 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 442 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 443 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 444 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 445 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 446 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 447 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 448 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 449 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 450 | <span class="hljs-attr">"avatar"</span>: { | |
| 451 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 452 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 453 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 454 | } | |
| 455 | } | |
| cc918ac3 C |
456 | </code></pre> |
| 457 | <!-- </div> --> | |
| 458 | </section> | |
| 459 | </div> | |
| 460 | </div> | |
| 461 | </div> | |
| ad9e39fb | 462 | <div id="operation--accounts--name--videos-get" class="operation panel" data-traverse-target="operation--accounts--name--videos-get"> |
| cc918ac3 C |
463 | <!-- <section class="operation-tags row"> --> |
| 464 | <!-- <div class="doc-copy"> --> | |
| 465 | <div class="operation-tags"> | |
| 466 | <a class="label" href="#tag-Accounts">Accounts</a> | |
| 467 | <!----> | |
| 468 | </div> | |
| 469 | <!-- </div> --> | |
| 470 | <!-- </section> --> | |
| 471 | <h2 class="operation-title"> | |
| 472 | <span class="operation-name"> | |
| 473 | <span class="operation-name">GET</span> | |
| ad9e39fb | 474 | <span class="operation-path">/accounts/{name}/videos</span> |
| cc918ac3 C |
475 | </span> |
| 476 | </h2> | |
| 477 | <div class="doc-row"> | |
| 478 | <div class="doc-copy"> | |
| 479 | <section class="swagger-request-params"> | |
| 480 | <div class="prop-row prop-group"> | |
| 481 | <div class="prop-name"> | |
| ad9e39fb | 482 | <div class="prop-title">name</div> |
| cc918ac3 C |
483 | <span class="json-property-required"></span> |
| 484 | <div class="prop-subtitle"> in path </div> | |
| 485 | <div class="prop-subtitle"> | |
| 486 | <span class="json-property-type">string</span> | |
| 487 | <span class="json-property-range" title="Value limits"></span> | |
| 488 | </div> | |
| 489 | </div> | |
| 490 | <div class="prop-value"> | |
| ad9e39fb C |
491 | <p>The name of the account (chocobozzz or |
| 492 | <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p> | |
| cc918ac3 C |
493 | </div> |
| 494 | </div> | |
| 495 | </section> | |
| 496 | </div> | |
| 497 | <div class="doc-examples"></div> | |
| 498 | </div> | |
| 499 | <div class="doc-row"> | |
| 500 | <div class="doc-copy"> | |
| 501 | <section class="swagger-responses"> | |
| 502 | <div class="prop-row prop-group"> | |
| 503 | <div class="prop-name"> | |
| 504 | <div class="prop-title">200 OK</div> | |
| 505 | <div class="prop-ref"> | |
| 506 | <span class=""> | |
| 507 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
| 508 | </span> | |
| 509 | </div> | |
| 510 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 511 | </div> | |
| 512 | <div class="prop-value"> | |
| 513 | <p>successful operation</p> | |
| 514 | </div> | |
| 515 | </div> | |
| 516 | </section> | |
| 517 | </div> | |
| 518 | <div class="doc-examples"> | |
| 519 | <h5>Response Content-Types: | |
| 520 | <span>application/json</span> | |
| 521 | </h5> | |
| 522 | <section> | |
| 523 | <h5>Response Example | |
| 524 | <span>(200 OK)</span> | |
| 525 | </h5> | |
| 526 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 527 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 528 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 529 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 530 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 531 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 532 | <span class="hljs-attr">"category"</span>: { | |
| 533 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 534 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 535 | }, | |
| 536 | <span class="hljs-attr">"licence"</span>: { | |
| 537 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 538 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 539 | }, | |
| 540 | <span class="hljs-attr">"language"</span>: { | |
| 541 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
| 542 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 543 | }, | |
| 544 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | |
| 545 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 546 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 547 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 548 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 549 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
| 550 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
| 551 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
| 552 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 553 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 554 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 555 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | |
| 556 | <span class="hljs-attr">"account"</span>: { | |
| 557 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 558 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 559 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 560 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 561 | <span class="hljs-attr">"avatar"</span>: { | |
| 562 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 563 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 564 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 565 | } | |
| 566 | } | |
| 567 | } | |
| 5e1c08eb C |
568 | </code></pre> |
| 569 | <!-- </div> --> | |
| 570 | </section> | |
| 571 | </div> | |
| 572 | </div> | |
| 573 | </div> | |
| 574 | <div id="operation--accounts-get" class="operation panel" data-traverse-target="operation--accounts-get"> | |
| 575 | <!-- <section class="operation-tags row"> --> | |
| 576 | <!-- <div class="doc-copy"> --> | |
| 577 | <div class="operation-tags"> | |
| 578 | <a class="label" href="#tag-Accounts">Accounts</a> | |
| 579 | <!----> | |
| 580 | </div> | |
| 581 | <!-- </div> --> | |
| 582 | <!-- </section> --> | |
| 583 | <h2 class="operation-title"> | |
| 584 | <span class="operation-name"> | |
| 585 | <span class="operation-name">GET</span> | |
| 586 | <span class="operation-path">/accounts</span> | |
| 587 | </span> | |
| 588 | </h2> | |
| 589 | <div class="doc-row"> | |
| 590 | <div class="doc-copy"> </div> | |
| 591 | <div class="doc-examples"></div> | |
| 592 | </div> | |
| 593 | <div class="doc-row"> | |
| 594 | <div class="doc-copy"> | |
| 595 | <section class="swagger-responses"> | |
| 596 | <div class="prop-row prop-group"> | |
| 597 | <div class="prop-name"> | |
| 598 | <div class="prop-title">200 OK</div> | |
| 599 | <div class="prop-ref"> | |
| 600 | <span class="json-schema-ref-array"> | |
| 601 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
| 602 | </span> | |
| 603 | </div> | |
| 604 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 605 | </div> | |
| 606 | <div class="prop-value"> | |
| 607 | <p>successful operation</p> | |
| 608 | </div> | |
| 609 | </div> | |
| 228e84aa C |
610 | <div class="prop-row prop-inner"> |
| 611 | <div class="prop-name">type</div> | |
| 612 | <div class="prop-value"> | |
| 613 | <span class="json-property-type"> | |
| 614 | <span class="json-schema-ref-array"> | |
| 615 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
| 616 | </span> | |
| 617 | </span> | |
| 618 | <span class="json-property-range" title="Value limits"></span> | |
| 619 | </div> | |
| 620 | </div> | |
| 5e1c08eb C |
621 | </section> |
| 622 | </div> | |
| 623 | <div class="doc-examples"> | |
| 624 | <h5>Response Content-Types: | |
| 625 | <span>application/json</span> | |
| 626 | </h5> | |
| 627 | <section> | |
| 628 | <h5>Response Example | |
| 629 | <span>(200 OK)</span> | |
| 630 | </h5> | |
| 631 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 632 | { | |
| 633 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 634 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 635 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 636 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 637 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 638 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 639 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 640 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 641 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 642 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 643 | <span class="hljs-attr">"avatar"</span>: { | |
| 644 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 645 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 646 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 647 | } | |
| 648 | } | |
| 649 | ] | |
| 650 | </code></pre> | |
| 651 | <!-- </div> --> | |
| 652 | </section> | |
| 653 | </div> | |
| 654 | </div> | |
| 655 | </div> | |
| 656 | <h1 id="tag-Config" class="swagger-summary-tag" data-traverse-target="tag-Config">Config</h1> | |
| 657 | <div id="operation--config-get" class="operation panel" data-traverse-target="operation--config-get"> | |
| 658 | <!-- <section class="operation-tags row"> --> | |
| 659 | <!-- <div class="doc-copy"> --> | |
| 660 | <div class="operation-tags"> | |
| 661 | <a class="label" href="#tag-Config">Config</a> | |
| 662 | <!----> | |
| 663 | </div> | |
| 664 | <!-- </div> --> | |
| 665 | <!-- </section> --> | |
| 666 | <h2 class="operation-title"> | |
| 667 | <span class="operation-name"> | |
| 668 | <span class="operation-name">GET</span> | |
| 669 | <span class="operation-path">/config</span> | |
| 670 | </span> | |
| 671 | </h2> | |
| 672 | <div class="doc-row"> | |
| 673 | <div class="doc-copy"> </div> | |
| 674 | <div class="doc-examples"></div> | |
| 675 | </div> | |
| 676 | <div class="doc-row"> | |
| 677 | <div class="doc-copy"> | |
| 678 | <section class="swagger-responses"> | |
| 679 | <div class="prop-row prop-group"> | |
| 680 | <div class="prop-name"> | |
| 681 | <div class="prop-title">200 OK</div> | |
| 682 | <div class="prop-ref"> | |
| 683 | <span class=""> | |
| 684 | <a class="json-schema-ref" href="#/definitions/ServerConfig">ServerConfig</a> | |
| 685 | </span> | |
| 686 | </div> | |
| 687 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 688 | </div> | |
| 689 | <div class="prop-value"> | |
| 690 | <p>successful operation</p> | |
| 691 | </div> | |
| 692 | </div> | |
| 693 | </section> | |
| 694 | </div> | |
| 695 | <div class="doc-examples"> | |
| 696 | <h5>Response Content-Types: | |
| 697 | <span>application/json</span> | |
| 698 | </h5> | |
| 699 | <section> | |
| 700 | <h5>Response Example | |
| 701 | <span>(200 OK)</span> | |
| 702 | </h5> | |
| 703 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 704 | <span class="hljs-attr">"signup"</span>: { | |
| 705 | <span class="hljs-attr">"allowed"</span>: <span class="hljs-string">"boolean"</span> | |
| 706 | }, | |
| 707 | <span class="hljs-attr">"transcoding"</span>: { | |
| 708 | <span class="hljs-attr">"enabledResolutions"</span>: [ | |
| 709 | <span class="hljs-string">"number"</span> | |
| 710 | ] | |
| 711 | }, | |
| 712 | <span class="hljs-attr">"avatar"</span>: { | |
| 713 | <span class="hljs-attr">"file"</span>: { | |
| 714 | <span class="hljs-attr">"size"</span>: { | |
| 715 | <span class="hljs-attr">"max"</span>: <span class="hljs-string">"number"</span> | |
| 716 | } | |
| 717 | }, | |
| 718 | <span class="hljs-attr">"extensions"</span>: [ | |
| 719 | <span class="hljs-string">"string"</span> | |
| 720 | ] | |
| 721 | }, | |
| 722 | <span class="hljs-attr">"video"</span>: { | |
| 723 | <span class="hljs-attr">"file"</span>: { | |
| 724 | <span class="hljs-attr">"extensions"</span>: [ | |
| 725 | <span class="hljs-string">"string"</span> | |
| 726 | ] | |
| 727 | } | |
| 728 | } | |
| 729 | } | |
| 730 | </code></pre> | |
| 731 | <!-- </div> --> | |
| 732 | </section> | |
| 733 | </div> | |
| 734 | </div> | |
| 735 | </div> | |
| 48dce1c9 C |
736 | <h1 id="tag-Feeds" class="swagger-summary-tag" data-traverse-target="tag-Feeds">Feeds</h1> |
| 737 | <div id="operation--feeds-videos.-format--get" class="operation panel" data-traverse-target="operation--feeds-videos.-format--get"> | |
| 738 | <!-- <section class="operation-tags row"> --> | |
| 739 | <!-- <div class="doc-copy"> --> | |
| 740 | <div class="operation-tags"> | |
| 741 | <a class="label" href="#tag-Feeds">Feeds</a> | |
| 742 | <!----> | |
| 743 | </div> | |
| 744 | <!-- </div> --> | |
| 745 | <!-- </section> --> | |
| 746 | <h2 class="operation-title"> | |
| 747 | <span class="operation-name"> | |
| 748 | <span class="operation-name">GET</span> | |
| 749 | <span class="operation-path">/feeds/videos.{format}</span> | |
| 750 | </span> | |
| 751 | </h2> | |
| 752 | <div class="doc-row"> | |
| 753 | <div class="doc-copy"> | |
| 754 | <section class="swagger-request-params"> | |
| 755 | <div class="prop-row prop-group"> | |
| 756 | <div class="prop-name"> | |
| 757 | <div class="prop-title">format</div> | |
| 758 | <span class="json-property-required"></span> | |
| 759 | <div class="prop-subtitle"> in path </div> | |
| 760 | <div class="prop-subtitle"> | |
| 761 | <span class="json-property-type">string</span> | |
| 762 | <span class="json-property-enum" title="Possible values"> | |
| 763 | <span class="json-property-enum-item json-property-enum-default-value">xml</span>, | |
| 764 | <span class="json-property-enum-item">atom</span>, | |
| 765 | <span class="json-property-enum-item">json</span> | |
| 766 | </span> | |
| 767 | <span class="json-property-range" title="Value limits"></span> | |
| 768 | <span class="json-property-default-value" title="Default value">xml</span> | |
| 769 | </div> | |
| 770 | </div> | |
| 771 | <div class="prop-value"> | |
| 772 | <p>The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and json to JSON FEED 1.0</p> | |
| 773 | </div> | |
| 774 | </div> | |
| 775 | <div class="prop-row prop-group"> | |
| 776 | <div class="prop-name"> | |
| 777 | <div class="prop-title">accountId</div> | |
| 778 | <div class="prop-subtitle"> in query </div> | |
| 779 | <div class="prop-subtitle"> | |
| 780 | <span class="json-property-type">number</span> | |
| 781 | <span class="json-property-range" title="Value limits"></span> | |
| 782 | </div> | |
| 783 | </div> | |
| 784 | <div class="prop-value"> | |
| 785 | <p>The id of the local account to filter to (beware, users IDs and not actors IDs which will return empty feeds</p> | |
| 786 | </div> | |
| 787 | </div> | |
| 788 | <div class="prop-row prop-group"> | |
| 789 | <div class="prop-name"> | |
| 790 | <div class="prop-title">accountName</div> | |
| 791 | <div class="prop-subtitle"> in query </div> | |
| 792 | <div class="prop-subtitle"> | |
| 793 | <span class="json-property-type">string</span> | |
| 794 | <span class="json-property-range" title="Value limits"></span> | |
| 795 | </div> | |
| 796 | </div> | |
| 797 | <div class="prop-value"> | |
| 798 | <p>The name of the local account to filter to</p> | |
| 799 | </div> | |
| 800 | </div> | |
| 801 | </section> | |
| 802 | </div> | |
| 803 | <div class="doc-examples"></div> | |
| 804 | </div> | |
| 805 | <div class="doc-row"> | |
| 806 | <div class="doc-copy"> | |
| 807 | <section class="swagger-responses"> | |
| 808 | <div class="prop-row prop-group"> | |
| 809 | <div class="prop-name"> | |
| 810 | <div class="prop-title">200 OK</div> | |
| 811 | </div> | |
| 812 | <div class="prop-value"> | |
| 813 | <p>successful operation</p> | |
| 814 | </div> | |
| 815 | </div> | |
| 816 | </section> | |
| 817 | </div> | |
| 818 | <div class="doc-examples"> | |
| 819 | <h5>Response Content-Types: | |
| 820 | <span>application/atom+xml, application/rss+xml, application/json</span> | |
| 821 | </h5> | |
| 822 | </div> | |
| 823 | </div> | |
| 824 | </div> | |
| 5e1c08eb C |
825 | <h1 id="tag-Job" class="swagger-summary-tag" data-traverse-target="tag-Job">Job</h1> |
| 826 | <div id="operation--jobs-get" class="operation panel" data-traverse-target="operation--jobs-get"> | |
| 827 | <!-- <section class="operation-tags row"> --> | |
| 828 | <!-- <div class="doc-copy"> --> | |
| 829 | <div class="operation-tags"> | |
| 830 | <a class="label" href="#tag-Job">Job</a> | |
| 831 | <!----> | |
| 832 | </div> | |
| 833 | <!-- </div> --> | |
| 834 | <!-- </section> --> | |
| 835 | <h2 class="operation-title"> | |
| 836 | <span class="operation-name"> | |
| 837 | <span class="operation-name">GET</span> | |
| 838 | <span class="operation-path">/jobs</span> | |
| 839 | </span> | |
| 840 | </h2> | |
| 841 | <div class="doc-row"> | |
| ab0ee6a1 C |
842 | <div class="doc-copy"> |
| 843 | <section class="swagger-request-params"> | |
| 844 | <div class="prop-row prop-group"> | |
| 845 | <div class="prop-name"> | |
| 846 | <div class="prop-title">state</div> | |
| 847 | <span class="json-property-required"></span> | |
| 228e84aa C |
848 | <div class="prop-subtitle"> in path </div> |
| 849 | <div class="prop-subtitle"> | |
| 850 | <span class="json-property-type">string</span> | |
| 851 | <span class="json-property-range" title="Value limits"></span> | |
| 852 | </div> | |
| ab0ee6a1 C |
853 | </div> |
| 854 | <div class="prop-value"> | |
| 855 | <p>The id of the account</p> | |
| 856 | </div> | |
| 857 | </div> | |
| ab0ee6a1 C |
858 | <div class="prop-row prop-group"> |
| 859 | <div class="prop-name"> | |
| 860 | <div class="prop-title">start</div> | |
| 228e84aa C |
861 | <div class="prop-subtitle"> in query </div> |
| 862 | <div class="prop-subtitle"> | |
| 863 | <span class="json-property-type">number</span> | |
| 864 | <span class="json-property-range" title="Value limits"></span> | |
| 865 | </div> | |
| ab0ee6a1 C |
866 | </div> |
| 867 | <div class="prop-value"> | |
| 868 | <p>starting page</p> | |
| 869 | </div> | |
| 870 | </div> | |
| ab0ee6a1 C |
871 | <div class="prop-row prop-group"> |
| 872 | <div class="prop-name"> | |
| 873 | <div class="prop-title">count</div> | |
| 228e84aa C |
874 | <div class="prop-subtitle"> in query </div> |
| 875 | <div class="prop-subtitle"> | |
| 876 | <span class="json-property-type">number</span> | |
| 877 | <span class="json-property-range" title="Value limits"></span> | |
| 878 | </div> | |
| ab0ee6a1 C |
879 | </div> |
| 880 | <div class="prop-value"> | |
| 881 | <p class="no-description">(no description)</p> | |
| 882 | </div> | |
| 883 | </div> | |
| ab0ee6a1 C |
884 | <div class="prop-row prop-group"> |
| 885 | <div class="prop-name"> | |
| 886 | <div class="prop-title">sort</div> | |
| 228e84aa C |
887 | <div class="prop-subtitle"> in query </div> |
| 888 | <div class="prop-subtitle"> | |
| 889 | <span class="json-property-type">number</span> | |
| 890 | <span class="json-property-range" title="Value limits"></span> | |
| 891 | </div> | |
| ab0ee6a1 C |
892 | </div> |
| 893 | <div class="prop-value"> | |
| 894 | <p>sorting</p> | |
| 895 | </div> | |
| 896 | </div> | |
| ab0ee6a1 C |
897 | </section> |
| 898 | </div> | |
| 5e1c08eb C |
899 | <div class="doc-examples"></div> |
| 900 | </div> | |
| 901 | <div class="doc-row"> | |
| 902 | <div class="doc-copy"> | |
| 903 | <section class="swagger-responses"> | |
| 904 | <div class="prop-row prop-group"> | |
| 905 | <div class="prop-name"> | |
| 906 | <div class="prop-title">200 OK</div> | |
| 907 | <div class="prop-ref"> | |
| 908 | <span class="json-schema-ref-array"> | |
| 909 | <a class="json-schema-ref" href="#/definitions/Job">Job</a> | |
| 910 | </span> | |
| 911 | </div> | |
| 912 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 913 | </div> | |
| 914 | <div class="prop-value"> | |
| 915 | <p>successful operation</p> | |
| 916 | </div> | |
| 917 | </div> | |
| 228e84aa C |
918 | <div class="prop-row prop-inner"> |
| 919 | <div class="prop-name">type</div> | |
| 920 | <div class="prop-value"> | |
| 921 | <span class="json-property-type"> | |
| 922 | <span class="json-schema-ref-array"> | |
| 923 | <a class="json-schema-ref" href="#/definitions/Job">Job</a> | |
| 924 | </span> | |
| 925 | </span> | |
| 926 | <span class="json-property-range" title="Value limits"></span> | |
| 927 | </div> | |
| 928 | </div> | |
| 5e1c08eb C |
929 | </section> |
| 930 | </div> | |
| 931 | <div class="doc-examples"> | |
| 932 | <h5>Response Content-Types: | |
| 933 | <span>application/json</span> | |
| 934 | </h5> | |
| 935 | <section> | |
| 936 | <h5>Response Example | |
| 937 | <span>(200 OK)</span> | |
| 938 | </h5> | |
| 939 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 940 | { | |
| 941 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 942 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
| 943 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"string"</span>, | |
| 944 | <span class="hljs-attr">"handlerName"</span>: <span class="hljs-string">"string"</span>, | |
| 945 | <span class="hljs-attr">"handlerInputData"</span>: <span class="hljs-string">"string"</span>, | |
| 946 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 947 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 948 | } | |
| 949 | ] | |
| 950 | </code></pre> | |
| 951 | <!-- </div> --> | |
| 952 | </section> | |
| 953 | </div> | |
| 954 | </div> | |
| 94ff4c23 C |
955 | <div class="doc-row"> |
| 956 | <div class="doc-copy"> | |
| 957 | <section class="swagger-request-security"> | |
| 958 | <table class="table"> | |
| 959 | <thead> | |
| 960 | <tr> | |
| 961 | <th class="swagger-request-security-schema"></th> | |
| 962 | <th class="swagger-request-security-scopes"></th> | |
| 963 | </tr> | |
| 964 | </thead> | |
| 965 | <tbody> | |
| 966 | <tr> | |
| 967 | <td> | |
| 968 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 969 | </td> | |
| 970 | <td> </td> | |
| 971 | </tr> | |
| 972 | </tbody> | |
| 973 | </table> | |
| 974 | </section> | |
| 975 | </div> | |
| 976 | </div> | |
| 5e1c08eb C |
977 | </div> |
| 978 | <h1 id="tag-ServerFollowing" class="swagger-summary-tag" data-traverse-target="tag-ServerFollowing">ServerFollowing</h1> | |
| 979 | <div id="operation--server-following--host--delete" class="operation panel" data-traverse-target="operation--server-following--host--delete"> | |
| 980 | <!-- <section class="operation-tags row"> --> | |
| 981 | <!-- <div class="doc-copy"> --> | |
| 982 | <div class="operation-tags"> | |
| 983 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
| 984 | <!----> | |
| 985 | </div> | |
| 986 | <!-- </div> --> | |
| 987 | <!-- </section> --> | |
| 988 | <h2 class="operation-title"> | |
| 989 | <span class="operation-name"> | |
| 990 | <span class="operation-name">DELETE</span> | |
| 991 | <span class="operation-path">/server/following/{host}</span> | |
| 992 | </span> | |
| 993 | </h2> | |
| 994 | <div class="doc-row"> | |
| 995 | <div class="doc-copy"> | |
| 996 | <section class="swagger-request-params"> | |
| 997 | <div class="prop-row prop-group"> | |
| 998 | <div class="prop-name"> | |
| 999 | <div class="prop-title">host</div> | |
| 1000 | <span class="json-property-required"></span> | |
| 228e84aa C |
1001 | <div class="prop-subtitle"> in path </div> |
| 1002 | <div class="prop-subtitle"> | |
| 1003 | <span class="json-property-type">string</span> | |
| 1004 | <span class="json-property-range" title="Value limits"></span> | |
| 1005 | </div> | |
| 5e1c08eb C |
1006 | </div> |
| 1007 | <div class="prop-value"> | |
| 1008 | <p>The host to unfollow </p> | |
| 1009 | </div> | |
| 1010 | </div> | |
| 5e1c08eb C |
1011 | </section> |
| 1012 | </div> | |
| 1013 | <div class="doc-examples"></div> | |
| 1014 | </div> | |
| 1015 | <div class="doc-row"> | |
| 1016 | <div class="doc-copy"> | |
| 1017 | <section class="swagger-responses"> | |
| 1018 | <div class="prop-row prop-group"> | |
| 1019 | <div class="prop-name"> | |
| 1020 | <div class="prop-title">201 Created</div> | |
| 1021 | </div> | |
| 1022 | <div class="prop-value"> | |
| 1023 | <p>successful operation</p> | |
| 1024 | </div> | |
| 1025 | </div> | |
| 1026 | </section> | |
| 1027 | </div> | |
| 1028 | <div class="doc-examples"> | |
| 1029 | <h5>Response Content-Types: | |
| 1030 | <span>application/json</span> | |
| 1031 | </h5> | |
| 1032 | </div> | |
| 1033 | </div> | |
| 94ff4c23 C |
1034 | <div class="doc-row"> |
| 1035 | <div class="doc-copy"> | |
| 1036 | <section class="swagger-request-security"> | |
| 1037 | <table class="table"> | |
| 1038 | <thead> | |
| 1039 | <tr> | |
| 1040 | <th class="swagger-request-security-schema"></th> | |
| 1041 | <th class="swagger-request-security-scopes"></th> | |
| 1042 | </tr> | |
| 1043 | </thead> | |
| 1044 | <tbody> | |
| 1045 | <tr> | |
| 1046 | <td> | |
| 1047 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 1048 | </td> | |
| 1049 | <td> </td> | |
| 1050 | </tr> | |
| 1051 | </tbody> | |
| 1052 | </table> | |
| 1053 | </section> | |
| 1054 | </div> | |
| 1055 | </div> | |
| 5e1c08eb C |
1056 | </div> |
| 1057 | <div id="operation--server-followers-get" class="operation panel" data-traverse-target="operation--server-followers-get"> | |
| 1058 | <!-- <section class="operation-tags row"> --> | |
| 1059 | <!-- <div class="doc-copy"> --> | |
| 1060 | <div class="operation-tags"> | |
| 1061 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
| 1062 | <!----> | |
| 1063 | </div> | |
| 1064 | <!-- </div> --> | |
| 1065 | <!-- </section> --> | |
| 1066 | <h2 class="operation-title"> | |
| 1067 | <span class="operation-name"> | |
| 1068 | <span class="operation-name">GET</span> | |
| 1069 | <span class="operation-path">/server/followers</span> | |
| 1070 | </span> | |
| 1071 | </h2> | |
| 1072 | <div class="doc-row"> | |
| ab0ee6a1 C |
1073 | <div class="doc-copy"> |
| 1074 | <section class="swagger-request-params"> | |
| 1075 | <div class="prop-row prop-group"> | |
| 1076 | <div class="prop-name"> | |
| 1077 | <div class="prop-title">start</div> | |
| 228e84aa C |
1078 | <div class="prop-subtitle"> in query </div> |
| 1079 | <div class="prop-subtitle"> | |
| 1080 | <span class="json-property-type">number</span> | |
| 1081 | <span class="json-property-range" title="Value limits"></span> | |
| 1082 | </div> | |
| ab0ee6a1 C |
1083 | </div> |
| 1084 | <div class="prop-value"> | |
| 1085 | <p>starting page</p> | |
| 1086 | </div> | |
| 1087 | </div> | |
| ab0ee6a1 C |
1088 | <div class="prop-row prop-group"> |
| 1089 | <div class="prop-name"> | |
| 1090 | <div class="prop-title">stop</div> | |
| 228e84aa C |
1091 | <div class="prop-subtitle"> in query </div> |
| 1092 | <div class="prop-subtitle"> | |
| 1093 | <span class="json-property-type">number</span> | |
| 1094 | <span class="json-property-range" title="Value limits"></span> | |
| 1095 | </div> | |
| ab0ee6a1 C |
1096 | </div> |
| 1097 | <div class="prop-value"> | |
| f209b32a | 1098 | <p>stopping page</p> |
| ab0ee6a1 C |
1099 | </div> |
| 1100 | </div> | |
| ab0ee6a1 C |
1101 | <div class="prop-row prop-group"> |
| 1102 | <div class="prop-name"> | |
| 1103 | <div class="prop-title">sort</div> | |
| 228e84aa C |
1104 | <div class="prop-subtitle"> in query </div> |
| 1105 | <div class="prop-subtitle"> | |
| 1106 | <span class="json-property-type">number</span> | |
| 1107 | <span class="json-property-range" title="Value limits"></span> | |
| 1108 | </div> | |
| ab0ee6a1 C |
1109 | </div> |
| 1110 | <div class="prop-value"> | |
| 1111 | <p>sorting</p> | |
| 1112 | </div> | |
| 1113 | </div> | |
| ab0ee6a1 C |
1114 | </section> |
| 1115 | </div> | |
| 5e1c08eb C |
1116 | <div class="doc-examples"></div> |
| 1117 | </div> | |
| 1118 | <div class="doc-row"> | |
| 1119 | <div class="doc-copy"> | |
| 1120 | <section class="swagger-responses"> | |
| 1121 | <div class="prop-row prop-group"> | |
| 1122 | <div class="prop-name"> | |
| 1123 | <div class="prop-title">200 OK</div> | |
| 1124 | <div class="prop-ref"> | |
| 1125 | <span class="json-schema-ref-array"> | |
| 1126 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
| 1127 | </span> | |
| 1128 | </div> | |
| 1129 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 1130 | </div> | |
| 1131 | <div class="prop-value"> | |
| 1132 | <p>successful operation</p> | |
| 1133 | </div> | |
| 1134 | </div> | |
| 228e84aa C |
1135 | <div class="prop-row prop-inner"> |
| 1136 | <div class="prop-name">type</div> | |
| 1137 | <div class="prop-value"> | |
| 1138 | <span class="json-property-type"> | |
| 1139 | <span class="json-schema-ref-array"> | |
| 1140 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
| 1141 | </span> | |
| 1142 | </span> | |
| 1143 | <span class="json-property-range" title="Value limits"></span> | |
| 1144 | </div> | |
| 1145 | </div> | |
| 5e1c08eb C |
1146 | </section> |
| 1147 | </div> | |
| 1148 | <div class="doc-examples"> | |
| 1149 | <h5>Response Content-Types: | |
| 1150 | <span>application/json</span> | |
| 1151 | </h5> | |
| 1152 | <section> | |
| 1153 | <h5>Response Example | |
| 1154 | <span>(200 OK)</span> | |
| 1155 | </h5> | |
| 1156 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 1157 | { | |
| 1158 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1159 | <span class="hljs-attr">"follower"</span>: { | |
| 1160 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1161 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 1162 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 1163 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 1164 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 1165 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1166 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1167 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1168 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1169 | <span class="hljs-attr">"avatar"</span>: { | |
| 1170 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 1171 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1172 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1173 | } | |
| 1174 | }, | |
| 1175 | <span class="hljs-attr">"following"</span>: { | |
| 1176 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1177 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 1178 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 1179 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 1180 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 1181 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1182 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1183 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1184 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1185 | <span class="hljs-attr">"avatar"</span>: { | |
| 1186 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 1187 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1188 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1189 | } | |
| 1190 | }, | |
| 1191 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
| 1192 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
| 1193 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1194 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1195 | } | |
| 1196 | ] | |
| 1197 | </code></pre> | |
| 1198 | <!-- </div> --> | |
| 1199 | </section> | |
| 1200 | </div> | |
| 1201 | </div> | |
| 1202 | </div> | |
| 1203 | <div id="operation--server-following-get" class="operation panel" data-traverse-target="operation--server-following-get"> | |
| 1204 | <!-- <section class="operation-tags row"> --> | |
| 1205 | <!-- <div class="doc-copy"> --> | |
| 1206 | <div class="operation-tags"> | |
| 1207 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
| 1208 | <!----> | |
| 1209 | </div> | |
| 1210 | <!-- </div> --> | |
| 1211 | <!-- </section> --> | |
| 1212 | <h2 class="operation-title"> | |
| 1213 | <span class="operation-name"> | |
| 1214 | <span class="operation-name">GET</span> | |
| 1215 | <span class="operation-path">/server/following</span> | |
| 1216 | </span> | |
| 1217 | </h2> | |
| 1218 | <div class="doc-row"> | |
| ab0ee6a1 C |
1219 | <div class="doc-copy"> |
| 1220 | <section class="swagger-request-params"> | |
| 1221 | <div class="prop-row prop-group"> | |
| 1222 | <div class="prop-name"> | |
| 1223 | <div class="prop-title">start</div> | |
| 228e84aa C |
1224 | <div class="prop-subtitle"> in query </div> |
| 1225 | <div class="prop-subtitle"> | |
| 1226 | <span class="json-property-type">number</span> | |
| 1227 | <span class="json-property-range" title="Value limits"></span> | |
| 1228 | </div> | |
| ab0ee6a1 C |
1229 | </div> |
| 1230 | <div class="prop-value"> | |
| 1231 | <p>starting page</p> | |
| 1232 | </div> | |
| 1233 | </div> | |
| ab0ee6a1 C |
1234 | <div class="prop-row prop-group"> |
| 1235 | <div class="prop-name"> | |
| 1236 | <div class="prop-title">stop</div> | |
| 228e84aa C |
1237 | <div class="prop-subtitle"> in query </div> |
| 1238 | <div class="prop-subtitle"> | |
| 1239 | <span class="json-property-type">number</span> | |
| 1240 | <span class="json-property-range" title="Value limits"></span> | |
| 1241 | </div> | |
| ab0ee6a1 C |
1242 | </div> |
| 1243 | <div class="prop-value"> | |
| f209b32a | 1244 | <p>stopping page</p> |
| ab0ee6a1 C |
1245 | </div> |
| 1246 | </div> | |
| ab0ee6a1 C |
1247 | <div class="prop-row prop-group"> |
| 1248 | <div class="prop-name"> | |
| 1249 | <div class="prop-title">sort</div> | |
| 228e84aa C |
1250 | <div class="prop-subtitle"> in query </div> |
| 1251 | <div class="prop-subtitle"> | |
| 1252 | <span class="json-property-type">number</span> | |
| 1253 | <span class="json-property-range" title="Value limits"></span> | |
| 1254 | </div> | |
| ab0ee6a1 C |
1255 | </div> |
| 1256 | <div class="prop-value"> | |
| 1257 | <p>sorting</p> | |
| 1258 | </div> | |
| 1259 | </div> | |
| ab0ee6a1 C |
1260 | </section> |
| 1261 | </div> | |
| 5e1c08eb C |
1262 | <div class="doc-examples"></div> |
| 1263 | </div> | |
| 1264 | <div class="doc-row"> | |
| 1265 | <div class="doc-copy"> | |
| 1266 | <section class="swagger-responses"> | |
| 1267 | <div class="prop-row prop-group"> | |
| 1268 | <div class="prop-name"> | |
| 1269 | <div class="prop-title">200 OK</div> | |
| 1270 | <div class="prop-ref"> | |
| 1271 | <span class="json-schema-ref-array"> | |
| 1272 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
| 1273 | </span> | |
| 1274 | </div> | |
| 1275 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 1276 | </div> | |
| 1277 | <div class="prop-value"> | |
| 1278 | <p>successful operation</p> | |
| 1279 | </div> | |
| 1280 | </div> | |
| 228e84aa C |
1281 | <div class="prop-row prop-inner"> |
| 1282 | <div class="prop-name">type</div> | |
| 1283 | <div class="prop-value"> | |
| 1284 | <span class="json-property-type"> | |
| 1285 | <span class="json-schema-ref-array"> | |
| 1286 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
| 1287 | </span> | |
| 1288 | </span> | |
| 1289 | <span class="json-property-range" title="Value limits"></span> | |
| 1290 | </div> | |
| 1291 | </div> | |
| 5e1c08eb C |
1292 | </section> |
| 1293 | </div> | |
| 1294 | <div class="doc-examples"> | |
| 1295 | <h5>Response Content-Types: | |
| 1296 | <span>application/json</span> | |
| 1297 | </h5> | |
| 1298 | <section> | |
| 1299 | <h5>Response Example | |
| 1300 | <span>(200 OK)</span> | |
| 1301 | </h5> | |
| 1302 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 1303 | { | |
| 1304 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1305 | <span class="hljs-attr">"follower"</span>: { | |
| 1306 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1307 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 1308 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 1309 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 1310 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 1311 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1312 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1313 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1314 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1315 | <span class="hljs-attr">"avatar"</span>: { | |
| 1316 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 1317 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1318 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1319 | } | |
| 1320 | }, | |
| 1321 | <span class="hljs-attr">"following"</span>: { | |
| 1322 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1323 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 1324 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 1325 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 1326 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 1327 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1328 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1329 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1330 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1331 | <span class="hljs-attr">"avatar"</span>: { | |
| 1332 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 1333 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1334 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1335 | } | |
| 1336 | }, | |
| 1337 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
| 1338 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
| 1339 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1340 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1341 | } | |
| 1342 | ] | |
| 1343 | </code></pre> | |
| 1344 | <!-- </div> --> | |
| 1345 | </section> | |
| 1346 | </div> | |
| 1347 | </div> | |
| 1348 | </div> | |
| 1349 | <div id="operation--server-following-post" class="operation panel" data-traverse-target="operation--server-following-post"> | |
| 1350 | <!-- <section class="operation-tags row"> --> | |
| 1351 | <!-- <div class="doc-copy"> --> | |
| 1352 | <div class="operation-tags"> | |
| 1353 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
| 1354 | <!----> | |
| 1355 | </div> | |
| 1356 | <!-- </div> --> | |
| 1357 | <!-- </section> --> | |
| 1358 | <h2 class="operation-title"> | |
| 1359 | <span class="operation-name"> | |
| 1360 | <span class="operation-name">POST</span> | |
| 1361 | <span class="operation-path">/server/following</span> | |
| 1362 | </span> | |
| 1363 | </h2> | |
| 1364 | <div class="doc-row"> | |
| 1365 | <div class="doc-copy"> | |
| 1366 | <section class="swagger-request-body"> | |
| 1367 | <div class="prop-row"> | |
| 1368 | <div class="prop-name"> | |
| 1369 | <div class="swagger-request-model"> | |
| 1370 | <span class=""> | |
| 1371 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
| 1372 | </span> | |
| 1373 | </div> | |
| 1374 | </div> | |
| 1375 | <div class="prop-value columns small-6"> | |
| 228e84aa C |
1376 | <!-- <div class="swagger-request-description"> --> |
| 1377 | <p>undefined</p> | |
| 5e1c08eb C |
1378 | <!-- </div> --> |
| 1379 | </div> | |
| 1380 | </div> | |
| 1381 | </section> | |
| 1382 | </div> | |
| 1383 | <div class="doc-examples"> | |
| 1384 | <section> | |
| 1385 | <h5>Request Content-Types: | |
| 1386 | <span>application/json</span> | |
| 1387 | </h5> | |
| 1388 | <h5>Request Example</h5> | |
| 1389 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 1390 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1391 | <span class="hljs-attr">"follower"</span>: { | |
| 1392 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1393 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 1394 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 1395 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 1396 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 1397 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1398 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1399 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1400 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1401 | <span class="hljs-attr">"avatar"</span>: { | |
| 1402 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 1403 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1404 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1405 | } | |
| 1406 | }, | |
| 1407 | <span class="hljs-attr">"following"</span>: { | |
| 1408 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1409 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 1410 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 1411 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 1412 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 1413 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1414 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1415 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1416 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1417 | <span class="hljs-attr">"avatar"</span>: { | |
| 1418 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 1419 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1420 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1421 | } | |
| 1422 | }, | |
| 1423 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
| 1424 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
| 1425 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1426 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1427 | } | |
| 1428 | </code></pre> | |
| 1429 | <!-- </div> --> | |
| 1430 | </section> | |
| 1431 | </div> | |
| 1432 | </div> | |
| 1433 | <div class="doc-row"> | |
| 1434 | <div class="doc-copy"> | |
| 1435 | <section class="swagger-responses"> | |
| 1436 | <div class="prop-row prop-group"> | |
| 1437 | <div class="prop-name"> | |
| 1438 | <div class="prop-title">204 No Content</div> | |
| 1439 | </div> | |
| 1440 | <div class="prop-value"> | |
| 1441 | <p>successful operation</p> | |
| 1442 | </div> | |
| 1443 | </div> | |
| 1444 | </section> | |
| 1445 | </div> | |
| 1446 | <div class="doc-examples"> | |
| 1447 | <h5>Response Content-Types: | |
| 1448 | <span>application/json</span> | |
| 1449 | </h5> | |
| 1450 | </div> | |
| 1451 | </div> | |
| 94ff4c23 C |
1452 | <div class="doc-row"> |
| 1453 | <div class="doc-copy"> | |
| 1454 | <section class="swagger-request-security"> | |
| 1455 | <table class="table"> | |
| 1456 | <thead> | |
| 1457 | <tr> | |
| 1458 | <th class="swagger-request-security-schema"></th> | |
| 1459 | <th class="swagger-request-security-scopes"></th> | |
| 1460 | </tr> | |
| 1461 | </thead> | |
| 1462 | <tbody> | |
| 1463 | <tr> | |
| 1464 | <td> | |
| 1465 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 1466 | </td> | |
| 1467 | <td> </td> | |
| 1468 | </tr> | |
| 1469 | </tbody> | |
| 1470 | </table> | |
| 1471 | </section> | |
| 1472 | </div> | |
| 1473 | </div> | |
| 5e1c08eb C |
1474 | </div> |
| 1475 | <h1 id="tag-User" class="swagger-summary-tag" data-traverse-target="tag-User">User</h1> | |
| 1476 | <div id="operation--users-post" class="operation panel" data-traverse-target="operation--users-post"> | |
| 1477 | <!-- <section class="operation-tags row"> --> | |
| 1478 | <!-- <div class="doc-copy"> --> | |
| 1479 | <div class="operation-tags"> | |
| 1480 | <a class="label" href="#tag-User">User</a> | |
| 1481 | <!----> | |
| 1482 | </div> | |
| 1483 | <!-- </div> --> | |
| 1484 | <!-- </section> --> | |
| 1485 | <h2 class="operation-title"> | |
| 1486 | <span class="operation-name"> | |
| 1487 | <span class="operation-name">POST</span> | |
| 1488 | <span class="operation-path">/users</span> | |
| 1489 | </span> | |
| 1490 | </h2> | |
| 1491 | <div class="doc-row"> | |
| 1492 | <div class="doc-copy"> | |
| 1493 | <section class="swagger-request-body"> | |
| 1494 | <div class="prop-row"> | |
| 1495 | <div class="prop-name"> | |
| 1496 | <div class="swagger-request-model"> | |
| 1497 | <span class=""> | |
| 1498 | <a class="json-schema-ref" href="#/definitions/AddUser">AddUser</a> | |
| 1499 | </span> | |
| 1500 | </div> | |
| 1501 | </div> | |
| 1502 | <div class="prop-value columns small-6"> | |
| 61b66b36 C |
1503 | <!-- <div class="swagger-request-description"> --> |
| 1504 | <p>User to create</p> | |
| 5e1c08eb C |
1505 | <!-- </div> --> |
| 1506 | </div> | |
| 1507 | </div> | |
| 1508 | </section> | |
| 1509 | </div> | |
| 1510 | <div class="doc-examples"> | |
| 1511 | <section> | |
| 1512 | <h5>Request Content-Types: | |
| 1513 | <span>application/json</span> | |
| 1514 | </h5> | |
| 1515 | <h5>Request Example</h5> | |
| 1516 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 1517 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
| 1518 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
| 1519 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 1520 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
| 1521 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
| 1522 | } | |
| 1523 | </code></pre> | |
| 1524 | <!-- </div> --> | |
| 1525 | </section> | |
| 1526 | </div> | |
| 1527 | </div> | |
| 1528 | <div class="doc-row"> | |
| 1529 | <div class="doc-copy"> | |
| 1530 | <section class="swagger-responses"> | |
| 1531 | <div class="prop-row prop-group"> | |
| 1532 | <div class="prop-name"> | |
| 1533 | <div class="prop-title">200 OK</div> | |
| 1534 | <div class="prop-ref"> | |
| 1535 | <span class=""> | |
| 1536 | <a class="json-schema-ref" href="#/definitions/AddUserResponse">AddUserResponse</a> | |
| 1537 | </span> | |
| 1538 | </div> | |
| 1539 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 1540 | </div> | |
| 1541 | <div class="prop-value"> | |
| 1542 | <p>successful operation</p> | |
| 1543 | </div> | |
| 1544 | </div> | |
| 1545 | </section> | |
| 1546 | </div> | |
| 1547 | <div class="doc-examples"> | |
| 1548 | <h5>Response Content-Types: | |
| 1549 | <span>application/json</span> | |
| 1550 | </h5> | |
| 1551 | <section> | |
| 1552 | <h5>Response Example | |
| 1553 | <span>(200 OK)</span> | |
| 1554 | </h5> | |
| 1555 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 1556 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1557 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
| 1558 | } | |
| 1559 | </code></pre> | |
| 1560 | <!-- </div> --> | |
| 1561 | </section> | |
| 1562 | </div> | |
| 1563 | </div> | |
| 94ff4c23 C |
1564 | <div class="doc-row"> |
| 1565 | <div class="doc-copy"> | |
| 1566 | <section class="swagger-request-security"> | |
| 1567 | <table class="table"> | |
| 1568 | <thead> | |
| 1569 | <tr> | |
| 1570 | <th class="swagger-request-security-schema"></th> | |
| 1571 | <th class="swagger-request-security-scopes"></th> | |
| 1572 | </tr> | |
| 1573 | </thead> | |
| 1574 | <tbody> | |
| 1575 | <tr> | |
| 1576 | <td> | |
| 1577 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 1578 | </td> | |
| 1579 | <td> </td> | |
| 1580 | </tr> | |
| 1581 | </tbody> | |
| 1582 | </table> | |
| 1583 | </section> | |
| 1584 | </div> | |
| 1585 | </div> | |
| 5e1c08eb C |
1586 | </div> |
| 1587 | <div id="operation--users-get" class="operation panel" data-traverse-target="operation--users-get"> | |
| 1588 | <!-- <section class="operation-tags row"> --> | |
| 1589 | <!-- <div class="doc-copy"> --> | |
| 1590 | <div class="operation-tags"> | |
| 1591 | <a class="label" href="#tag-User">User</a> | |
| 1592 | <!----> | |
| 1593 | </div> | |
| 1594 | <!-- </div> --> | |
| 1595 | <!-- </section> --> | |
| 1596 | <h2 class="operation-title"> | |
| 1597 | <span class="operation-name"> | |
| 1598 | <span class="operation-name">GET</span> | |
| 1599 | <span class="operation-path">/users</span> | |
| 1600 | </span> | |
| 1601 | </h2> | |
| 1602 | <div class="doc-row"> | |
| ab0ee6a1 C |
1603 | <div class="doc-copy"> |
| 1604 | <section class="swagger-request-params"> | |
| 1605 | <div class="prop-row prop-group"> | |
| 1606 | <div class="prop-name"> | |
| 1607 | <div class="prop-title">start</div> | |
| 228e84aa C |
1608 | <div class="prop-subtitle"> in query </div> |
| 1609 | <div class="prop-subtitle"> | |
| 1610 | <span class="json-property-type">number</span> | |
| 1611 | <span class="json-property-range" title="Value limits"></span> | |
| 1612 | </div> | |
| ab0ee6a1 C |
1613 | </div> |
| 1614 | <div class="prop-value"> | |
| 1615 | <p>starting page</p> | |
| 1616 | </div> | |
| 1617 | </div> | |
| ab0ee6a1 C |
1618 | <div class="prop-row prop-group"> |
| 1619 | <div class="prop-name"> | |
| 1620 | <div class="prop-title">stop</div> | |
| 228e84aa C |
1621 | <div class="prop-subtitle"> in query </div> |
| 1622 | <div class="prop-subtitle"> | |
| 1623 | <span class="json-property-type">number</span> | |
| 1624 | <span class="json-property-range" title="Value limits"></span> | |
| 1625 | </div> | |
| ab0ee6a1 C |
1626 | </div> |
| 1627 | <div class="prop-value"> | |
| f209b32a | 1628 | <p>stopping page</p> |
| ab0ee6a1 C |
1629 | </div> |
| 1630 | </div> | |
| ab0ee6a1 C |
1631 | <div class="prop-row prop-group"> |
| 1632 | <div class="prop-name"> | |
| 1633 | <div class="prop-title">sort</div> | |
| 228e84aa C |
1634 | <div class="prop-subtitle"> in query </div> |
| 1635 | <div class="prop-subtitle"> | |
| 1636 | <span class="json-property-type">number</span> | |
| 1637 | <span class="json-property-range" title="Value limits"></span> | |
| 1638 | </div> | |
| ab0ee6a1 C |
1639 | </div> |
| 1640 | <div class="prop-value"> | |
| 1641 | <p>sorting</p> | |
| 1642 | </div> | |
| 1643 | </div> | |
| ab0ee6a1 C |
1644 | </section> |
| 1645 | </div> | |
| 5e1c08eb C |
1646 | <div class="doc-examples"></div> |
| 1647 | </div> | |
| 1648 | <div class="doc-row"> | |
| 1649 | <div class="doc-copy"> | |
| 1650 | <section class="swagger-responses"> | |
| 1651 | <div class="prop-row prop-group"> | |
| 1652 | <div class="prop-name"> | |
| 1653 | <div class="prop-title">200 OK</div> | |
| 1654 | <div class="prop-ref"> | |
| 1655 | <span class="json-schema-ref-array"> | |
| 1656 | <a class="json-schema-ref" href="#/definitions/User">User</a> | |
| 1657 | </span> | |
| 1658 | </div> | |
| 1659 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 1660 | </div> | |
| 1661 | <div class="prop-value"> | |
| 1662 | <p>successful operation</p> | |
| 1663 | </div> | |
| 1664 | </div> | |
| 228e84aa C |
1665 | <div class="prop-row prop-inner"> |
| 1666 | <div class="prop-name">type</div> | |
| 1667 | <div class="prop-value"> | |
| 1668 | <span class="json-property-type"> | |
| 1669 | <span class="json-schema-ref-array"> | |
| 1670 | <a class="json-schema-ref" href="#/definitions/User">User</a> | |
| 1671 | </span> | |
| 1672 | </span> | |
| 1673 | <span class="json-property-range" title="Value limits"></span> | |
| 1674 | </div> | |
| 1675 | </div> | |
| 5e1c08eb C |
1676 | </section> |
| 1677 | </div> | |
| 1678 | <div class="doc-examples"> | |
| 1679 | <h5>Response Content-Types: | |
| 1680 | <span>application/json</span> | |
| 1681 | </h5> | |
| 1682 | <section> | |
| 1683 | <h5>Response Example | |
| 1684 | <span>(200 OK)</span> | |
| 1685 | </h5> | |
| 1686 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 1687 | { | |
| 1688 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1689 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
| 1690 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 1691 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
| 1692 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
| 1693 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
| 1694 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
| 1695 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1696 | <span class="hljs-attr">"account"</span>: { | |
| 1697 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 1698 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1699 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 1700 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 1701 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 1702 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 1703 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1704 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1705 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1706 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1707 | <span class="hljs-attr">"avatar"</span>: { | |
| 1708 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 1709 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1710 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1711 | } | |
| 1712 | }, | |
| 1713 | <span class="hljs-attr">"videoChannels"</span>: [ | |
| 1714 | { | |
| 1715 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 1716 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 1717 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| cc918ac3 C |
1718 | <span class="hljs-attr">"ownerAccount"</span>: { |
| 1719 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5e1c08eb | 1720 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> |
| cc918ac3 | 1721 | } |
| 5e1c08eb C |
1722 | } |
| 1723 | ] | |
| 1724 | } | |
| 1725 | ] | |
| 1726 | </code></pre> | |
| 1727 | <!-- </div> --> | |
| 1728 | </section> | |
| 1729 | </div> | |
| 1730 | </div> | |
| 94ff4c23 C |
1731 | <div class="doc-row"> |
| 1732 | <div class="doc-copy"> | |
| 1733 | <section class="swagger-request-security"> | |
| 1734 | <table class="table"> | |
| 1735 | <thead> | |
| 1736 | <tr> | |
| 1737 | <th class="swagger-request-security-schema"></th> | |
| 1738 | <th class="swagger-request-security-scopes"></th> | |
| 1739 | </tr> | |
| 1740 | </thead> | |
| 1741 | <tbody> | |
| 1742 | <tr> | |
| 1743 | <td> | |
| 1744 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 1745 | </td> | |
| 1746 | <td> </td> | |
| 1747 | </tr> | |
| 1748 | </tbody> | |
| 1749 | </table> | |
| 1750 | </section> | |
| 1751 | </div> | |
| 1752 | </div> | |
| 5e1c08eb C |
1753 | </div> |
| 1754 | <div id="operation--users--id--delete" class="operation panel" data-traverse-target="operation--users--id--delete"> | |
| 1755 | <!-- <section class="operation-tags row"> --> | |
| 1756 | <!-- <div class="doc-copy"> --> | |
| 1757 | <div class="operation-tags"> | |
| 1758 | <a class="label" href="#tag-User">User</a> | |
| 1759 | <!----> | |
| 1760 | </div> | |
| 1761 | <!-- </div> --> | |
| 1762 | <!-- </section> --> | |
| 1763 | <h2 class="operation-title"> | |
| 1764 | <span class="operation-name"> | |
| 1765 | <span class="operation-name">DELETE</span> | |
| 1766 | <span class="operation-path">/users/{id}</span> | |
| 1767 | </span> | |
| 1768 | </h2> | |
| 1769 | <div class="doc-row"> | |
| 1770 | <div class="doc-copy"> | |
| 1771 | <section class="swagger-request-params"> | |
| 1772 | <div class="prop-row prop-group"> | |
| 1773 | <div class="prop-name"> | |
| 1774 | <div class="prop-title">id</div> | |
| 1775 | <span class="json-property-required"></span> | |
| 228e84aa C |
1776 | <div class="prop-subtitle"> in path </div> |
| 1777 | <div class="prop-subtitle"> | |
| 1778 | <span class="json-property-type">string</span> | |
| 1779 | <span class="json-property-range" title="Value limits"></span> | |
| 1780 | </div> | |
| 5e1c08eb C |
1781 | </div> |
| 1782 | <div class="prop-value"> | |
| 1783 | <p>The user id </p> | |
| 1784 | </div> | |
| 1785 | </div> | |
| 5e1c08eb C |
1786 | </section> |
| 1787 | </div> | |
| 1788 | <div class="doc-examples"></div> | |
| 1789 | </div> | |
| 1790 | <div class="doc-row"> | |
| 1791 | <div class="doc-copy"> | |
| 1792 | <section class="swagger-responses"> | |
| 1793 | <div class="prop-row prop-group"> | |
| 1794 | <div class="prop-name"> | |
| 1795 | <div class="prop-title">204 No Content</div> | |
| 1796 | </div> | |
| 1797 | <div class="prop-value"> | |
| 1798 | <p>successful operation</p> | |
| 1799 | </div> | |
| 1800 | </div> | |
| 1801 | </section> | |
| 1802 | </div> | |
| 1803 | <div class="doc-examples"> | |
| 1804 | <h5>Response Content-Types: | |
| 1805 | <span>application/json</span> | |
| 1806 | </h5> | |
| 1807 | </div> | |
| 1808 | </div> | |
| 94ff4c23 C |
1809 | <div class="doc-row"> |
| 1810 | <div class="doc-copy"> | |
| 1811 | <section class="swagger-request-security"> | |
| 1812 | <table class="table"> | |
| 1813 | <thead> | |
| 1814 | <tr> | |
| 1815 | <th class="swagger-request-security-schema"></th> | |
| 1816 | <th class="swagger-request-security-scopes"></th> | |
| 1817 | </tr> | |
| 1818 | </thead> | |
| 1819 | <tbody> | |
| 1820 | <tr> | |
| 1821 | <td> | |
| 1822 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 1823 | </td> | |
| 1824 | <td> </td> | |
| 1825 | </tr> | |
| 1826 | </tbody> | |
| 1827 | </table> | |
| 1828 | </section> | |
| 1829 | </div> | |
| 1830 | </div> | |
| 5e1c08eb C |
1831 | </div> |
| 1832 | <div id="operation--users--id--get" class="operation panel" data-traverse-target="operation--users--id--get"> | |
| 1833 | <!-- <section class="operation-tags row"> --> | |
| 1834 | <!-- <div class="doc-copy"> --> | |
| 1835 | <div class="operation-tags"> | |
| 1836 | <a class="label" href="#tag-User">User</a> | |
| 1837 | <!----> | |
| 1838 | </div> | |
| 1839 | <!-- </div> --> | |
| 1840 | <!-- </section> --> | |
| 1841 | <h2 class="operation-title"> | |
| 1842 | <span class="operation-name"> | |
| 1843 | <span class="operation-name">GET</span> | |
| 1844 | <span class="operation-path">/users/{id}</span> | |
| 1845 | </span> | |
| 1846 | </h2> | |
| 1847 | <div class="doc-row"> | |
| 1848 | <div class="doc-copy"> | |
| 1849 | <section class="swagger-request-params"> | |
| 1850 | <div class="prop-row prop-group"> | |
| 1851 | <div class="prop-name"> | |
| 1852 | <div class="prop-title">id</div> | |
| 1853 | <span class="json-property-required"></span> | |
| 228e84aa C |
1854 | <div class="prop-subtitle"> in path </div> |
| 1855 | <div class="prop-subtitle"> | |
| 1856 | <span class="json-property-type">string</span> | |
| 1857 | <span class="json-property-range" title="Value limits"></span> | |
| 1858 | </div> | |
| 5e1c08eb C |
1859 | </div> |
| 1860 | <div class="prop-value"> | |
| 1861 | <p>The user id </p> | |
| 1862 | </div> | |
| 1863 | </div> | |
| 5e1c08eb C |
1864 | </section> |
| 1865 | </div> | |
| 1866 | <div class="doc-examples"></div> | |
| 1867 | </div> | |
| 1868 | <div class="doc-row"> | |
| 1869 | <div class="doc-copy"> | |
| 1870 | <section class="swagger-responses"> | |
| 1871 | <div class="prop-row prop-group"> | |
| 1872 | <div class="prop-name"> | |
| 1873 | <div class="prop-title">200 OK</div> | |
| 1874 | <div class="prop-ref"> | |
| 1875 | <span class=""> | |
| 1876 | <a class="json-schema-ref" href="#/definitions/User">User</a> | |
| 1877 | </span> | |
| 1878 | </div> | |
| 1879 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 1880 | </div> | |
| 1881 | <div class="prop-value"> | |
| 1882 | <p>successful operation</p> | |
| 1883 | </div> | |
| 1884 | </div> | |
| 1885 | </section> | |
| 1886 | </div> | |
| 1887 | <div class="doc-examples"> | |
| 1888 | <h5>Response Content-Types: | |
| 1889 | <span>application/json</span> | |
| 1890 | </h5> | |
| 1891 | <section> | |
| 1892 | <h5>Response Example | |
| 1893 | <span>(200 OK)</span> | |
| 1894 | </h5> | |
| 1895 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 1896 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1897 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
| 1898 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 1899 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
| 1900 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
| 1901 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
| 1902 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
| 1903 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1904 | <span class="hljs-attr">"account"</span>: { | |
| 1905 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 1906 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1907 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 1908 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 1909 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 1910 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 1911 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1912 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1913 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1914 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1915 | <span class="hljs-attr">"avatar"</span>: { | |
| 1916 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 1917 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1918 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1919 | } | |
| 1920 | }, | |
| 1921 | <span class="hljs-attr">"videoChannels"</span>: [ | |
| 1922 | { | |
| 1923 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 1924 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 1925 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| cc918ac3 C |
1926 | <span class="hljs-attr">"ownerAccount"</span>: { |
| 1927 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5e1c08eb | 1928 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> |
| cc918ac3 | 1929 | } |
| 5e1c08eb C |
1930 | } |
| 1931 | ] | |
| 1932 | } | |
| 1933 | </code></pre> | |
| 1934 | <!-- </div> --> | |
| 1935 | </section> | |
| 1936 | </div> | |
| 1937 | </div> | |
| 94ff4c23 C |
1938 | <div class="doc-row"> |
| 1939 | <div class="doc-copy"> | |
| 1940 | <section class="swagger-request-security"> | |
| 1941 | <table class="table"> | |
| 1942 | <thead> | |
| 1943 | <tr> | |
| 1944 | <th class="swagger-request-security-schema"></th> | |
| 1945 | <th class="swagger-request-security-scopes"></th> | |
| 1946 | </tr> | |
| 1947 | </thead> | |
| 1948 | <tbody> | |
| 1949 | <tr> | |
| 1950 | <td> | |
| 1951 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 1952 | </td> | |
| 1953 | <td> </td> | |
| 1954 | </tr> | |
| 1955 | </tbody> | |
| 1956 | </table> | |
| 1957 | </section> | |
| 1958 | </div> | |
| 1959 | </div> | |
| 5e1c08eb C |
1960 | </div> |
| 1961 | <div id="operation--users--id--put" class="operation panel" data-traverse-target="operation--users--id--put"> | |
| 1962 | <!-- <section class="operation-tags row"> --> | |
| 1963 | <!-- <div class="doc-copy"> --> | |
| 1964 | <div class="operation-tags"> | |
| 1965 | <a class="label" href="#tag-User">User</a> | |
| 1966 | <!----> | |
| 1967 | </div> | |
| 1968 | <!-- </div> --> | |
| 1969 | <!-- </section> --> | |
| 1970 | <h2 class="operation-title"> | |
| 1971 | <span class="operation-name"> | |
| 1972 | <span class="operation-name">PUT</span> | |
| 1973 | <span class="operation-path">/users/{id}</span> | |
| 1974 | </span> | |
| 1975 | </h2> | |
| 1976 | <div class="doc-row"> | |
| 1977 | <div class="doc-copy"> | |
| 1978 | <section class="swagger-request-body"> | |
| 1979 | <div class="prop-row"> | |
| 1980 | <div class="prop-name"> | |
| 1981 | <div class="swagger-request-model"> | |
| 1982 | <span class=""> | |
| 1983 | <a class="json-schema-ref" href="#/definitions/UpdateUser">UpdateUser</a> | |
| 1984 | </span> | |
| 1985 | </div> | |
| 1986 | </div> | |
| 1987 | <div class="prop-value columns small-6"> | |
| 228e84aa C |
1988 | <!-- <div class="swagger-request-description"> --> |
| 1989 | <p>undefined</p> | |
| 5e1c08eb C |
1990 | <!-- </div> --> |
| 1991 | </div> | |
| 1992 | </div> | |
| 1993 | </section> | |
| 1994 | <section class="swagger-request-params"> | |
| 1995 | <div class="prop-row prop-group"> | |
| 1996 | <div class="prop-name"> | |
| 1997 | <div class="prop-title">id</div> | |
| 1998 | <span class="json-property-required"></span> | |
| 228e84aa C |
1999 | <div class="prop-subtitle"> in path </div> |
| 2000 | <div class="prop-subtitle"> | |
| 2001 | <span class="json-property-type">string</span> | |
| 2002 | <span class="json-property-range" title="Value limits"></span> | |
| 2003 | </div> | |
| 5e1c08eb C |
2004 | </div> |
| 2005 | <div class="prop-value"> | |
| 2006 | <p>The user id </p> | |
| 2007 | </div> | |
| 2008 | </div> | |
| 5e1c08eb C |
2009 | </section> |
| 2010 | </div> | |
| 2011 | <div class="doc-examples"> | |
| 2012 | <section> | |
| 2013 | <h5>Request Content-Types: | |
| 2014 | <span>application/json</span> | |
| 2015 | </h5> | |
| 2016 | <h5>Request Example</h5> | |
| 2017 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 2018 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
| 2019 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 2020 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
| 2021 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
| 2022 | } | |
| 2023 | </code></pre> | |
| 2024 | <!-- </div> --> | |
| 2025 | </section> | |
| 2026 | </div> | |
| 2027 | </div> | |
| 2028 | <div class="doc-row"> | |
| 2029 | <div class="doc-copy"> | |
| 2030 | <section class="swagger-responses"> | |
| 2031 | <div class="prop-row prop-group"> | |
| 2032 | <div class="prop-name"> | |
| 2033 | <div class="prop-title">204 No Content</div> | |
| 2034 | </div> | |
| 2035 | <div class="prop-value"> | |
| 2036 | <p>successful operation</p> | |
| 2037 | </div> | |
| 2038 | </div> | |
| 2039 | </section> | |
| 2040 | </div> | |
| 2041 | <div class="doc-examples"> | |
| 2042 | <h5>Response Content-Types: | |
| 2043 | <span>application/json</span> | |
| 2044 | </h5> | |
| 2045 | </div> | |
| 2046 | </div> | |
| 94ff4c23 C |
2047 | <div class="doc-row"> |
| 2048 | <div class="doc-copy"> | |
| 2049 | <section class="swagger-request-security"> | |
| 2050 | <table class="table"> | |
| 2051 | <thead> | |
| 2052 | <tr> | |
| 2053 | <th class="swagger-request-security-schema"></th> | |
| 2054 | <th class="swagger-request-security-scopes"></th> | |
| 2055 | </tr> | |
| 2056 | </thead> | |
| 2057 | <tbody> | |
| 2058 | <tr> | |
| 2059 | <td> | |
| 2060 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 2061 | </td> | |
| 2062 | <td> </td> | |
| 2063 | </tr> | |
| 2064 | </tbody> | |
| 2065 | </table> | |
| 2066 | </section> | |
| 2067 | </div> | |
| 2068 | </div> | |
| 5e1c08eb C |
2069 | </div> |
| 2070 | <div id="operation--users-me-get" class="operation panel" data-traverse-target="operation--users-me-get"> | |
| 2071 | <!-- <section class="operation-tags row"> --> | |
| 2072 | <!-- <div class="doc-copy"> --> | |
| 2073 | <div class="operation-tags"> | |
| 2074 | <a class="label" href="#tag-User">User</a> | |
| 2075 | <!----> | |
| 2076 | </div> | |
| 2077 | <!-- </div> --> | |
| 2078 | <!-- </section> --> | |
| 2079 | <h2 class="operation-title"> | |
| 2080 | <span class="operation-name"> | |
| 2081 | <span class="operation-name">GET</span> | |
| 2082 | <span class="operation-path">/users/me</span> | |
| 2083 | </span> | |
| 2084 | </h2> | |
| 2085 | <div class="doc-row"> | |
| 2086 | <div class="doc-copy"> </div> | |
| 2087 | <div class="doc-examples"></div> | |
| 2088 | </div> | |
| 2089 | <div class="doc-row"> | |
| 2090 | <div class="doc-copy"> | |
| 2091 | <section class="swagger-responses"> | |
| 2092 | <div class="prop-row prop-group"> | |
| 2093 | <div class="prop-name"> | |
| 2094 | <div class="prop-title">200 OK</div> | |
| 2095 | <div class="prop-ref"> | |
| 2096 | <span class="json-schema-ref-array"> | |
| 2097 | <a class="json-schema-ref" href="#/definitions/User">User</a> | |
| 2098 | </span> | |
| 2099 | </div> | |
| 2100 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 2101 | </div> | |
| 2102 | <div class="prop-value"> | |
| 2103 | <p>successful operation</p> | |
| 2104 | </div> | |
| 2105 | </div> | |
| 228e84aa C |
2106 | <div class="prop-row prop-inner"> |
| 2107 | <div class="prop-name">type</div> | |
| 2108 | <div class="prop-value"> | |
| 2109 | <span class="json-property-type"> | |
| 2110 | <span class="json-schema-ref-array"> | |
| 2111 | <a class="json-schema-ref" href="#/definitions/User">User</a> | |
| 2112 | </span> | |
| 2113 | </span> | |
| 2114 | <span class="json-property-range" title="Value limits"></span> | |
| 2115 | </div> | |
| 2116 | </div> | |
| 5e1c08eb C |
2117 | </section> |
| 2118 | </div> | |
| 2119 | <div class="doc-examples"> | |
| 2120 | <h5>Response Content-Types: | |
| 2121 | <span>application/json</span> | |
| 2122 | </h5> | |
| 2123 | <section> | |
| 2124 | <h5>Response Example | |
| 2125 | <span>(200 OK)</span> | |
| 2126 | </h5> | |
| 2127 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 2128 | { | |
| 2129 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2130 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
| 2131 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 2132 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
| 2133 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
| 2134 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
| 2135 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
| 2136 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 2137 | <span class="hljs-attr">"account"</span>: { | |
| 2138 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 2139 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2140 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 2141 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 2142 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 2143 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 2144 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 2145 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 2146 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 2147 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 2148 | <span class="hljs-attr">"avatar"</span>: { | |
| 2149 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 2150 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 2151 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 2152 | } | |
| 2153 | }, | |
| 2154 | <span class="hljs-attr">"videoChannels"</span>: [ | |
| 2155 | { | |
| 2156 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 2157 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 2158 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| cc918ac3 C |
2159 | <span class="hljs-attr">"ownerAccount"</span>: { |
| 2160 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5e1c08eb | 2161 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> |
| cc918ac3 | 2162 | } |
| 5e1c08eb C |
2163 | } |
| 2164 | ] | |
| 2165 | } | |
| 2166 | ] | |
| 2167 | </code></pre> | |
| 2168 | <!-- </div> --> | |
| 2169 | </section> | |
| 2170 | </div> | |
| 2171 | </div> | |
| 94ff4c23 C |
2172 | <div class="doc-row"> |
| 2173 | <div class="doc-copy"> | |
| 2174 | <section class="swagger-request-security"> | |
| 2175 | <table class="table"> | |
| 2176 | <thead> | |
| 2177 | <tr> | |
| 2178 | <th class="swagger-request-security-schema"></th> | |
| 2179 | <th class="swagger-request-security-scopes"></th> | |
| 2180 | </tr> | |
| 2181 | </thead> | |
| 2182 | <tbody> | |
| 2183 | <tr> | |
| 2184 | <td> | |
| 2185 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 2186 | </td> | |
| 2187 | <td> </td> | |
| 2188 | </tr> | |
| 2189 | </tbody> | |
| 2190 | </table> | |
| 2191 | </section> | |
| 2192 | </div> | |
| 2193 | </div> | |
| 5e1c08eb C |
2194 | </div> |
| 2195 | <div id="operation--users-me-put" class="operation panel" data-traverse-target="operation--users-me-put"> | |
| 2196 | <!-- <section class="operation-tags row"> --> | |
| 2197 | <!-- <div class="doc-copy"> --> | |
| 2198 | <div class="operation-tags"> | |
| 2199 | <a class="label" href="#tag-User">User</a> | |
| 2200 | <!----> | |
| 2201 | </div> | |
| 2202 | <!-- </div> --> | |
| 2203 | <!-- </section> --> | |
| 2204 | <h2 class="operation-title"> | |
| 2205 | <span class="operation-name"> | |
| 2206 | <span class="operation-name">PUT</span> | |
| 2207 | <span class="operation-path">/users/me</span> | |
| 2208 | </span> | |
| 2209 | </h2> | |
| 2210 | <div class="doc-row"> | |
| 2211 | <div class="doc-copy"> | |
| 2212 | <section class="swagger-request-body"> | |
| 2213 | <div class="prop-row"> | |
| 2214 | <div class="prop-name"> | |
| 2215 | <div class="swagger-request-model"> | |
| 2216 | <span class=""> | |
| 2217 | <a class="json-schema-ref" href="#/definitions/UpdateMe">UpdateMe</a> | |
| 2218 | </span> | |
| 2219 | </div> | |
| 2220 | </div> | |
| 2221 | <div class="prop-value columns small-6"> | |
| 228e84aa C |
2222 | <!-- <div class="swagger-request-description"> --> |
| 2223 | <p>undefined</p> | |
| 5e1c08eb C |
2224 | <!-- </div> --> |
| 2225 | </div> | |
| 2226 | </div> | |
| 2227 | </section> | |
| 2228 | </div> | |
| 2229 | <div class="doc-examples"> | |
| 2230 | <section> | |
| 2231 | <h5>Request Content-Types: | |
| 2232 | <span>application/json</span> | |
| 2233 | </h5> | |
| 2234 | <h5>Request Example</h5> | |
| 2235 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 2236 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
| 2237 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 2238 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"string"</span>, | |
| 2239 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"string"</span> | |
| 2240 | } | |
| 2241 | </code></pre> | |
| 2242 | <!-- </div> --> | |
| 2243 | </section> | |
| 2244 | </div> | |
| 2245 | </div> | |
| 2246 | <div class="doc-row"> | |
| 2247 | <div class="doc-copy"> | |
| 2248 | <section class="swagger-responses"> | |
| 2249 | <div class="prop-row prop-group"> | |
| 2250 | <div class="prop-name"> | |
| 2251 | <div class="prop-title">204 No Content</div> | |
| 2252 | </div> | |
| 2253 | <div class="prop-value"> | |
| 2254 | <p>successful operation</p> | |
| 2255 | </div> | |
| 2256 | </div> | |
| 2257 | </section> | |
| 2258 | </div> | |
| 2259 | <div class="doc-examples"> | |
| 2260 | <h5>Response Content-Types: | |
| 2261 | <span>application/json</span> | |
| 2262 | </h5> | |
| 2263 | </div> | |
| 2264 | </div> | |
| 94ff4c23 C |
2265 | <div class="doc-row"> |
| 2266 | <div class="doc-copy"> | |
| 2267 | <section class="swagger-request-security"> | |
| 2268 | <table class="table"> | |
| 2269 | <thead> | |
| 2270 | <tr> | |
| 2271 | <th class="swagger-request-security-schema"></th> | |
| 2272 | <th class="swagger-request-security-scopes"></th> | |
| 2273 | </tr> | |
| 2274 | </thead> | |
| 2275 | <tbody> | |
| 2276 | <tr> | |
| 2277 | <td> | |
| 2278 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 2279 | </td> | |
| 2280 | <td> </td> | |
| 2281 | </tr> | |
| 2282 | </tbody> | |
| 2283 | </table> | |
| 2284 | </section> | |
| 2285 | </div> | |
| 2286 | </div> | |
| 5e1c08eb C |
2287 | </div> |
| 2288 | <div id="operation--users-me-video-quota-used-get" class="operation panel" data-traverse-target="operation--users-me-video-quota-used-get"> | |
| 2289 | <!-- <section class="operation-tags row"> --> | |
| 2290 | <!-- <div class="doc-copy"> --> | |
| 2291 | <div class="operation-tags"> | |
| 2292 | <a class="label" href="#tag-User">User</a> | |
| 2293 | <!----> | |
| 2294 | </div> | |
| 2295 | <!-- </div> --> | |
| 2296 | <!-- </section> --> | |
| 2297 | <h2 class="operation-title"> | |
| 2298 | <span class="operation-name"> | |
| 2299 | <span class="operation-name">GET</span> | |
| 2300 | <span class="operation-path">/users/me/video-quota-used</span> | |
| 2301 | </span> | |
| 2302 | </h2> | |
| 2303 | <div class="doc-row"> | |
| 2304 | <div class="doc-copy"> </div> | |
| 2305 | <div class="doc-examples"></div> | |
| 2306 | </div> | |
| 2307 | <div class="doc-row"> | |
| 2308 | <div class="doc-copy"> | |
| 2309 | <section class="swagger-responses"> | |
| 2310 | <div class="prop-row prop-group"> | |
| 2311 | <div class="prop-name"> | |
| 2312 | <div class="prop-title">200 OK</div> | |
| 2313 | <div class="prop-ref"></div> | |
| 2314 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 2315 | </div> | |
| 2316 | <div class="prop-value"> | |
| 2317 | <p>successful operation</p> | |
| 2318 | </div> | |
| 2319 | </div> | |
| 228e84aa C |
2320 | <div class="prop-row prop-inner"> |
| 2321 | <div class="prop-name">type</div> | |
| 2322 | <div class="prop-value"> | |
| 2323 | <span class="json-property-type">number</span> | |
| 2324 | <span class="json-property-range" title="Value limits"></span> | |
| 2325 | </div> | |
| 2326 | </div> | |
| 5e1c08eb C |
2327 | </section> |
| 2328 | </div> | |
| 2329 | <div class="doc-examples"> | |
| 2330 | <h5>Response Content-Types: | |
| 2331 | <span>application/json</span> | |
| 2332 | </h5> | |
| 2333 | <section> | |
| 2334 | <h5>Response Example | |
| 2335 | <span>(200 OK)</span> | |
| 2336 | </h5> | |
| 2337 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">"number"</span> | |
| 2338 | </code></pre> | |
| 2339 | <!-- </div> --> | |
| 2340 | </section> | |
| 2341 | </div> | |
| 2342 | </div> | |
| 94ff4c23 C |
2343 | <div class="doc-row"> |
| 2344 | <div class="doc-copy"> | |
| 2345 | <section class="swagger-request-security"> | |
| 2346 | <table class="table"> | |
| 2347 | <thead> | |
| 2348 | <tr> | |
| 2349 | <th class="swagger-request-security-schema"></th> | |
| 2350 | <th class="swagger-request-security-scopes"></th> | |
| 2351 | </tr> | |
| 2352 | </thead> | |
| 2353 | <tbody> | |
| 2354 | <tr> | |
| 2355 | <td> | |
| 2356 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 2357 | </td> | |
| 2358 | <td> </td> | |
| 2359 | </tr> | |
| 2360 | </tbody> | |
| 2361 | </table> | |
| 2362 | </section> | |
| 2363 | </div> | |
| 2364 | </div> | |
| 5e1c08eb C |
2365 | </div> |
| 2366 | <div id="operation--users-me-videos--videoId--rating-get" class="operation panel" data-traverse-target="operation--users-me-videos--videoId--rating-get"> | |
| 2367 | <!-- <section class="operation-tags row"> --> | |
| 2368 | <!-- <div class="doc-copy"> --> | |
| 2369 | <div class="operation-tags"> | |
| 2370 | <a class="label" href="#tag-User">User</a> | |
| 2371 | <!----> | |
| 2372 | </div> | |
| 2373 | <!-- </div> --> | |
| 2374 | <!-- </section> --> | |
| 2375 | <h2 class="operation-title"> | |
| 2376 | <span class="operation-name"> | |
| 2377 | <span class="operation-name">GET</span> | |
| 2378 | <span class="operation-path">/users/me/videos/{videoId}/rating</span> | |
| 2379 | </span> | |
| 2380 | </h2> | |
| 2381 | <div class="doc-row"> | |
| 2382 | <div class="doc-copy"> | |
| 2383 | <section class="swagger-request-params"> | |
| 2384 | <div class="prop-row prop-group"> | |
| 2385 | <div class="prop-name"> | |
| 2386 | <div class="prop-title">videoId</div> | |
| 2387 | <span class="json-property-required"></span> | |
| 228e84aa C |
2388 | <div class="prop-subtitle"> in path </div> |
| 2389 | <div class="prop-subtitle"> | |
| 2390 | <span class="json-property-type">string</span> | |
| 2391 | <span class="json-property-range" title="Value limits"></span> | |
| 2392 | </div> | |
| 5e1c08eb C |
2393 | </div> |
| 2394 | <div class="prop-value"> | |
| 2395 | <p>The video id </p> | |
| 2396 | </div> | |
| 2397 | </div> | |
| 5e1c08eb C |
2398 | </section> |
| 2399 | </div> | |
| 2400 | <div class="doc-examples"></div> | |
| 2401 | </div> | |
| 2402 | <div class="doc-row"> | |
| 2403 | <div class="doc-copy"> | |
| 2404 | <section class="swagger-responses"> | |
| 2405 | <div class="prop-row prop-group"> | |
| 2406 | <div class="prop-name"> | |
| 2407 | <div class="prop-title">200 OK</div> | |
| 2408 | <div class="prop-ref"> | |
| 2409 | <span class=""> | |
| 2410 | <a class="json-schema-ref" href="#/definitions/GetMeVideoRating">GetMeVideoRating</a> | |
| 2411 | </span> | |
| 2412 | </div> | |
| 2413 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 2414 | </div> | |
| 2415 | <div class="prop-value"> | |
| 2416 | <p>successful operation</p> | |
| 2417 | </div> | |
| 2418 | </div> | |
| 2419 | </section> | |
| 2420 | </div> | |
| 2421 | <div class="doc-examples"> | |
| 2422 | <h5>Response Content-Types: | |
| 2423 | <span>application/json</span> | |
| 2424 | </h5> | |
| 2425 | <section> | |
| 2426 | <h5>Response Example | |
| 2427 | <span>(200 OK)</span> | |
| 2428 | </h5> | |
| 2429 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 2430 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
| 2431 | <span class="hljs-attr">"rating"</span>: <span class="hljs-string">"number"</span> | |
| 2432 | } | |
| 2433 | </code></pre> | |
| 2434 | <!-- </div> --> | |
| 2435 | </section> | |
| 2436 | </div> | |
| 2437 | </div> | |
| 94ff4c23 C |
2438 | <div class="doc-row"> |
| 2439 | <div class="doc-copy"> | |
| 2440 | <section class="swagger-request-security"> | |
| 2441 | <table class="table"> | |
| 2442 | <thead> | |
| 2443 | <tr> | |
| 2444 | <th class="swagger-request-security-schema"></th> | |
| 2445 | <th class="swagger-request-security-scopes"></th> | |
| 2446 | </tr> | |
| 2447 | </thead> | |
| 2448 | <tbody> | |
| 2449 | <tr> | |
| 2450 | <td> | |
| 2451 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 2452 | </td> | |
| 2453 | <td> </td> | |
| 2454 | </tr> | |
| 2455 | </tbody> | |
| 2456 | </table> | |
| 2457 | </section> | |
| 2458 | </div> | |
| 2459 | </div> | |
| 5e1c08eb C |
2460 | </div> |
| 2461 | <div id="operation--users-me-videos-get" class="operation panel" data-traverse-target="operation--users-me-videos-get"> | |
| 2462 | <!-- <section class="operation-tags row"> --> | |
| 2463 | <!-- <div class="doc-copy"> --> | |
| 2464 | <div class="operation-tags"> | |
| 2465 | <a class="label" href="#tag-User">User</a> | |
| 2466 | <!----> | |
| 2467 | </div> | |
| 2468 | <!-- </div> --> | |
| 2469 | <!-- </section> --> | |
| 2470 | <h2 class="operation-title"> | |
| 2471 | <span class="operation-name"> | |
| 2472 | <span class="operation-name">GET</span> | |
| 2473 | <span class="operation-path">/users/me/videos</span> | |
| 2474 | </span> | |
| 2475 | </h2> | |
| 2476 | <div class="doc-row"> | |
| ab0ee6a1 C |
2477 | <div class="doc-copy"> |
| 2478 | <section class="swagger-request-params"> | |
| 2479 | <div class="prop-row prop-group"> | |
| 2480 | <div class="prop-name"> | |
| 2481 | <div class="prop-title">start</div> | |
| 228e84aa C |
2482 | <div class="prop-subtitle"> in query </div> |
| 2483 | <div class="prop-subtitle"> | |
| 2484 | <span class="json-property-type">number</span> | |
| 2485 | <span class="json-property-range" title="Value limits"></span> | |
| 2486 | </div> | |
| ab0ee6a1 C |
2487 | </div> |
| 2488 | <div class="prop-value"> | |
| 2489 | <p>starting page</p> | |
| 2490 | </div> | |
| 2491 | </div> | |
| ab0ee6a1 C |
2492 | <div class="prop-row prop-group"> |
| 2493 | <div class="prop-name"> | |
| 2494 | <div class="prop-title">stop</div> | |
| 228e84aa C |
2495 | <div class="prop-subtitle"> in query </div> |
| 2496 | <div class="prop-subtitle"> | |
| 2497 | <span class="json-property-type">number</span> | |
| 2498 | <span class="json-property-range" title="Value limits"></span> | |
| 2499 | </div> | |
| ab0ee6a1 C |
2500 | </div> |
| 2501 | <div class="prop-value"> | |
| f209b32a | 2502 | <p>stopping page</p> |
| ab0ee6a1 C |
2503 | </div> |
| 2504 | </div> | |
| ab0ee6a1 C |
2505 | <div class="prop-row prop-group"> |
| 2506 | <div class="prop-name"> | |
| 2507 | <div class="prop-title">sort</div> | |
| 228e84aa C |
2508 | <div class="prop-subtitle"> in query </div> |
| 2509 | <div class="prop-subtitle"> | |
| 2510 | <span class="json-property-type">number</span> | |
| 2511 | <span class="json-property-range" title="Value limits"></span> | |
| 2512 | </div> | |
| ab0ee6a1 C |
2513 | </div> |
| 2514 | <div class="prop-value"> | |
| 2515 | <p>sorting</p> | |
| 2516 | </div> | |
| 2517 | </div> | |
| ab0ee6a1 C |
2518 | </section> |
| 2519 | </div> | |
| 5e1c08eb C |
2520 | <div class="doc-examples"></div> |
| 2521 | </div> | |
| 2522 | <div class="doc-row"> | |
| 2523 | <div class="doc-copy"> | |
| 2524 | <section class="swagger-responses"> | |
| 2525 | <div class="prop-row prop-group"> | |
| 2526 | <div class="prop-name"> | |
| 2527 | <div class="prop-title">200 OK</div> | |
| 2528 | <div class="prop-ref"> | |
| 2529 | <span class="json-schema-ref-array"> | |
| 2530 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
| 2531 | </span> | |
| 2532 | </div> | |
| 2533 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 2534 | </div> | |
| 2535 | <div class="prop-value"> | |
| 2536 | <p>successful operation</p> | |
| 2537 | </div> | |
| 2538 | </div> | |
| 228e84aa C |
2539 | <div class="prop-row prop-inner"> |
| 2540 | <div class="prop-name">type</div> | |
| 2541 | <div class="prop-value"> | |
| 2542 | <span class="json-property-type"> | |
| 2543 | <span class="json-schema-ref-array"> | |
| 2544 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
| 2545 | </span> | |
| 2546 | </span> | |
| 2547 | <span class="json-property-range" title="Value limits"></span> | |
| 2548 | </div> | |
| 2549 | </div> | |
| 5e1c08eb C |
2550 | </section> |
| 2551 | </div> | |
| 2552 | <div class="doc-examples"> | |
| 2553 | <h5>Response Content-Types: | |
| 2554 | <span>application/json</span> | |
| 2555 | </h5> | |
| 2556 | <section> | |
| 2557 | <h5>Response Example | |
| 2558 | <span>(200 OK)</span> | |
| 2559 | </h5> | |
| 2560 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 2561 | { | |
| 2562 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2563 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 5e1c08eb | 2564 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
| 61b66b36 | 2565 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb | 2566 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, |
| 5d00a3d7 C |
2567 | <span class="hljs-attr">"category"</span>: { |
| 2568 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2569 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 2570 | }, | |
| 2571 | <span class="hljs-attr">"licence"</span>: { | |
| 2572 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2573 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 2574 | }, | |
| 2575 | <span class="hljs-attr">"language"</span>: { | |
| 48dce1c9 | 2576 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
| 5d00a3d7 C |
2577 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
| 2578 | }, | |
| 61b66b36 | 2579 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb C |
2580 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
| 2581 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 2582 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 2583 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 5e1c08eb C |
2584 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
| 2585 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
| 2586 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
| 2587 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 2588 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 2589 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 61b66b36 C |
2590 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, |
| 2591 | <span class="hljs-attr">"account"</span>: { | |
| 2592 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 2593 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 2594 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 2595 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 2596 | <span class="hljs-attr">"avatar"</span>: { | |
| 2597 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 2598 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 2599 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 2600 | } | |
| 2601 | } | |
| 5e1c08eb C |
2602 | } |
| 2603 | ] | |
| 2604 | </code></pre> | |
| 2605 | <!-- </div> --> | |
| 2606 | </section> | |
| 2607 | </div> | |
| 2608 | </div> | |
| 94ff4c23 C |
2609 | <div class="doc-row"> |
| 2610 | <div class="doc-copy"> | |
| 2611 | <section class="swagger-request-security"> | |
| 2612 | <table class="table"> | |
| 2613 | <thead> | |
| 2614 | <tr> | |
| 2615 | <th class="swagger-request-security-schema"></th> | |
| 2616 | <th class="swagger-request-security-scopes"></th> | |
| 2617 | </tr> | |
| 2618 | </thead> | |
| 2619 | <tbody> | |
| 2620 | <tr> | |
| 2621 | <td> | |
| 2622 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 2623 | </td> | |
| 2624 | <td> </td> | |
| 2625 | </tr> | |
| 2626 | </tbody> | |
| 2627 | </table> | |
| 2628 | </section> | |
| 2629 | </div> | |
| 2630 | </div> | |
| 5e1c08eb C |
2631 | </div> |
| 2632 | <div id="operation--users-register-post" class="operation panel" data-traverse-target="operation--users-register-post"> | |
| 2633 | <!-- <section class="operation-tags row"> --> | |
| 2634 | <!-- <div class="doc-copy"> --> | |
| 2635 | <div class="operation-tags"> | |
| 2636 | <a class="label" href="#tag-User">User</a> | |
| 2637 | <!----> | |
| 2638 | </div> | |
| 2639 | <!-- </div> --> | |
| 2640 | <!-- </section> --> | |
| 2641 | <h2 class="operation-title"> | |
| 2642 | <span class="operation-name"> | |
| 2643 | <span class="operation-name">POST</span> | |
| 2644 | <span class="operation-path">/users/register</span> | |
| 2645 | </span> | |
| 2646 | </h2> | |
| 2647 | <div class="doc-row"> | |
| 2648 | <div class="doc-copy"> | |
| 2649 | <section class="swagger-request-body"> | |
| 2650 | <div class="prop-row"> | |
| 2651 | <div class="prop-name"> | |
| 2652 | <div class="swagger-request-model"> | |
| 2653 | <span class=""> | |
| 2654 | <a class="json-schema-ref" href="#/definitions/RegisterUser">RegisterUser</a> | |
| 2655 | </span> | |
| 2656 | </div> | |
| 2657 | </div> | |
| 2658 | <div class="prop-value columns small-6"> | |
| 228e84aa C |
2659 | <!-- <div class="swagger-request-description"> --> |
| 2660 | <p>undefined</p> | |
| 5e1c08eb C |
2661 | <!-- </div> --> |
| 2662 | </div> | |
| 2663 | </div> | |
| 2664 | </section> | |
| 2665 | </div> | |
| 2666 | <div class="doc-examples"> | |
| 2667 | <section> | |
| 2668 | <h5>Request Content-Types: | |
| 2669 | <span>application/json</span> | |
| 2670 | </h5> | |
| 2671 | <h5>Request Example</h5> | |
| 2672 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 2673 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
| 2674 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
| 2675 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span> | |
| 2676 | } | |
| 2677 | </code></pre> | |
| 2678 | <!-- </div> --> | |
| 2679 | </section> | |
| 2680 | </div> | |
| 2681 | </div> | |
| 2682 | <div class="doc-row"> | |
| 2683 | <div class="doc-copy"> | |
| 2684 | <section class="swagger-responses"> | |
| 2685 | <div class="prop-row prop-group"> | |
| 2686 | <div class="prop-name"> | |
| 2687 | <div class="prop-title">204 No Content</div> | |
| 2688 | </div> | |
| 2689 | <div class="prop-value"> | |
| 2690 | <p>successful operation</p> | |
| 2691 | </div> | |
| 2692 | </div> | |
| 2693 | </section> | |
| 2694 | </div> | |
| 2695 | <div class="doc-examples"> | |
| 2696 | <h5>Response Content-Types: | |
| 2697 | <span>application/json</span> | |
| 2698 | </h5> | |
| 2699 | </div> | |
| 2700 | </div> | |
| 2701 | </div> | |
| 2702 | <div id="operation--users-me-avatar-pick-post" class="operation panel" data-traverse-target="operation--users-me-avatar-pick-post"> | |
| 2703 | <!-- <section class="operation-tags row"> --> | |
| 2704 | <!-- <div class="doc-copy"> --> | |
| 2705 | <div class="operation-tags"> | |
| 2706 | <a class="label" href="#tag-User">User</a> | |
| 2707 | <!----> | |
| 2708 | </div> | |
| 2709 | <!-- </div> --> | |
| 2710 | <!-- </section> --> | |
| 2711 | <h2 class="operation-title"> | |
| 2712 | <span class="operation-name"> | |
| 2713 | <span class="operation-name">POST</span> | |
| 2714 | <span class="operation-path">/users/me/avatar/pick</span> | |
| 2715 | </span> | |
| 2716 | </h2> | |
| 2717 | <div class="doc-row"> | |
| 2718 | <div class="doc-copy"> | |
| 2719 | <section class="swagger-request-params"> | |
| 2720 | <div class="prop-row prop-group"> | |
| 2721 | <div class="prop-name"> | |
| 2722 | <div class="prop-title">avatarfile</div> | |
| 228e84aa C |
2723 | <div class="prop-subtitle"> in formData </div> |
| 2724 | <div class="prop-subtitle"> | |
| 2725 | <span class="json-property-type">file</span> | |
| 2726 | <span class="json-property-range" title="Value limits"></span> | |
| 2727 | </div> | |
| 5e1c08eb C |
2728 | </div> |
| 2729 | <div class="prop-value"> | |
| 2730 | <p>The file to upload.</p> | |
| 2731 | </div> | |
| 2732 | </div> | |
| 5e1c08eb C |
2733 | </section> |
| 2734 | </div> | |
| 2735 | <div class="doc-examples"></div> | |
| 2736 | </div> | |
| 2737 | <div class="doc-row"> | |
| 2738 | <div class="doc-copy"> | |
| 2739 | <section class="swagger-responses"> | |
| 2740 | <div class="prop-row prop-group"> | |
| 2741 | <div class="prop-name"> | |
| 2742 | <div class="prop-title">200 OK</div> | |
| 2743 | <div class="prop-ref"> | |
| 2744 | <span class=""> | |
| 2745 | <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a> | |
| 2746 | </span> | |
| 2747 | </div> | |
| 2748 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 2749 | </div> | |
| 2750 | <div class="prop-value"> | |
| 2751 | <p>successful operation</p> | |
| 2752 | </div> | |
| 2753 | </div> | |
| 2754 | </section> | |
| 2755 | </div> | |
| 2756 | <div class="doc-examples"> | |
| 2757 | <h5>Response Content-Types: | |
| 2758 | <span>application/json</span> | |
| 2759 | </h5> | |
| 2760 | <section> | |
| 2761 | <h5>Response Example | |
| 2762 | <span>(200 OK)</span> | |
| 2763 | </h5> | |
| 2764 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 2765 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 2766 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 2767 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 2768 | } | |
| 2769 | </code></pre> | |
| 2770 | <!-- </div> --> | |
| 2771 | </section> | |
| 2772 | </div> | |
| ab0ee6a1 | 2773 | </div> |
| 94ff4c23 C |
2774 | <div class="doc-row"> |
| 2775 | <div class="doc-copy"> | |
| 2776 | <section class="swagger-request-security"> | |
| 2777 | <table class="table"> | |
| 2778 | <thead> | |
| 2779 | <tr> | |
| 2780 | <th class="swagger-request-security-schema"></th> | |
| 2781 | <th class="swagger-request-security-scopes"></th> | |
| 2782 | </tr> | |
| 2783 | </thead> | |
| 2784 | <tbody> | |
| 2785 | <tr> | |
| 2786 | <td> | |
| 2787 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 2788 | </td> | |
| 2789 | <td> </td> | |
| 2790 | </tr> | |
| 2791 | </tbody> | |
| 2792 | </table> | |
| 2793 | </section> | |
| 2794 | </div> | |
| 2795 | </div> | |
| ab0ee6a1 C |
2796 | </div> |
| 2797 | <h1 id="tag-Video" class="swagger-summary-tag" data-traverse-target="tag-Video">Video</h1> | |
| 2798 | <div id="operation--videos-get" class="operation panel" data-traverse-target="operation--videos-get"> | |
| 2799 | <!-- <section class="operation-tags row"> --> | |
| 2800 | <!-- <div class="doc-copy"> --> | |
| 2801 | <div class="operation-tags"> | |
| 2802 | <a class="label" href="#tag-Video">Video</a> | |
| 2803 | <!----> | |
| 2804 | </div> | |
| 2805 | <!-- </div> --> | |
| 2806 | <!-- </section> --> | |
| 2807 | <h2 class="operation-title"> | |
| 2808 | <span class="operation-name"> | |
| 2809 | <span class="operation-name">GET</span> | |
| 2810 | <span class="operation-path">/videos</span> | |
| 2811 | </span> | |
| 2812 | </h2> | |
| 2813 | <div class="doc-row"> | |
| 2814 | <div class="doc-copy"> | |
| 2815 | <section class="swagger-request-params"> | |
| 2816 | <div class="prop-row prop-group"> | |
| 2817 | <div class="prop-name"> | |
| 2818 | <div class="prop-title">start</div> | |
| 228e84aa C |
2819 | <div class="prop-subtitle"> in query </div> |
| 2820 | <div class="prop-subtitle"> | |
| 2821 | <span class="json-property-type">number</span> | |
| 2822 | <span class="json-property-range" title="Value limits"></span> | |
| 2823 | </div> | |
| ab0ee6a1 C |
2824 | </div> |
| 2825 | <div class="prop-value"> | |
| 2826 | <p>starting page</p> | |
| 2827 | </div> | |
| 2828 | </div> | |
| ab0ee6a1 C |
2829 | <div class="prop-row prop-group"> |
| 2830 | <div class="prop-name"> | |
| 2831 | <div class="prop-title">stop</div> | |
| 228e84aa C |
2832 | <div class="prop-subtitle"> in query </div> |
| 2833 | <div class="prop-subtitle"> | |
| 2834 | <span class="json-property-type">number</span> | |
| 2835 | <span class="json-property-range" title="Value limits"></span> | |
| 2836 | </div> | |
| ab0ee6a1 C |
2837 | </div> |
| 2838 | <div class="prop-value"> | |
| f209b32a | 2839 | <p>stopping page</p> |
| ab0ee6a1 C |
2840 | </div> |
| 2841 | </div> | |
| ab0ee6a1 C |
2842 | <div class="prop-row prop-group"> |
| 2843 | <div class="prop-name"> | |
| 2844 | <div class="prop-title">sort</div> | |
| 228e84aa C |
2845 | <div class="prop-subtitle"> in query </div> |
| 2846 | <div class="prop-subtitle"> | |
| 2847 | <span class="json-property-type">number</span> | |
| 2848 | <span class="json-property-range" title="Value limits"></span> | |
| 2849 | </div> | |
| ab0ee6a1 C |
2850 | </div> |
| 2851 | <div class="prop-value"> | |
| 2852 | <p>sorting</p> | |
| 2853 | </div> | |
| 2854 | </div> | |
| ab0ee6a1 C |
2855 | </section> |
| 2856 | </div> | |
| 5e1c08eb C |
2857 | <div class="doc-examples"></div> |
| 2858 | </div> | |
| 2859 | <div class="doc-row"> | |
| 2860 | <div class="doc-copy"> | |
| 2861 | <section class="swagger-responses"> | |
| 2862 | <div class="prop-row prop-group"> | |
| 2863 | <div class="prop-name"> | |
| 2864 | <div class="prop-title">200 OK</div> | |
| 2865 | <div class="prop-ref"> | |
| 2866 | <span class="json-schema-ref-array"> | |
| 2867 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
| 2868 | </span> | |
| 2869 | </div> | |
| 2870 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 2871 | </div> | |
| 2872 | <div class="prop-value"> | |
| 2873 | <p>successful operation</p> | |
| 2874 | </div> | |
| 2875 | </div> | |
| 228e84aa C |
2876 | <div class="prop-row prop-inner"> |
| 2877 | <div class="prop-name">type</div> | |
| 2878 | <div class="prop-value"> | |
| 2879 | <span class="json-property-type"> | |
| 2880 | <span class="json-schema-ref-array"> | |
| 2881 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
| 2882 | </span> | |
| 2883 | </span> | |
| 2884 | <span class="json-property-range" title="Value limits"></span> | |
| 2885 | </div> | |
| 2886 | </div> | |
| 5e1c08eb C |
2887 | </section> |
| 2888 | </div> | |
| 2889 | <div class="doc-examples"> | |
| 2890 | <h5>Response Content-Types: | |
| 2891 | <span>application/json</span> | |
| 2892 | </h5> | |
| 2893 | <section> | |
| 2894 | <h5>Response Example | |
| 2895 | <span>(200 OK)</span> | |
| 2896 | </h5> | |
| 2897 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 2898 | { | |
| 2899 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2900 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 5e1c08eb | 2901 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
| 61b66b36 | 2902 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb | 2903 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, |
| 5d00a3d7 C |
2904 | <span class="hljs-attr">"category"</span>: { |
| 2905 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2906 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 2907 | }, | |
| 2908 | <span class="hljs-attr">"licence"</span>: { | |
| 2909 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2910 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 2911 | }, | |
| 2912 | <span class="hljs-attr">"language"</span>: { | |
| 48dce1c9 | 2913 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
| 5d00a3d7 C |
2914 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
| 2915 | }, | |
| 61b66b36 | 2916 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb C |
2917 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
| 2918 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 2919 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 2920 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 5e1c08eb C |
2921 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
| 2922 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
| 2923 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
| 2924 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 2925 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 2926 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 61b66b36 C |
2927 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, |
| 2928 | <span class="hljs-attr">"account"</span>: { | |
| 2929 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 2930 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 2931 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 2932 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 2933 | <span class="hljs-attr">"avatar"</span>: { | |
| 2934 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 2935 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 2936 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 2937 | } | |
| 2938 | } | |
| 5e1c08eb C |
2939 | } |
| 2940 | ] | |
| 2941 | </code></pre> | |
| 2942 | <!-- </div> --> | |
| 2943 | </section> | |
| 2944 | </div> | |
| 2945 | </div> | |
| 2946 | </div> | |
| ab0ee6a1 | 2947 | <div id="operation--videos-categories-get" class="operation panel" data-traverse-target="operation--videos-categories-get"> |
| 5e1c08eb C |
2948 | <!-- <section class="operation-tags row"> --> |
| 2949 | <!-- <div class="doc-copy"> --> | |
| 2950 | <div class="operation-tags"> | |
| 2951 | <a class="label" href="#tag-Video">Video</a> | |
| 2952 | <!----> | |
| 2953 | </div> | |
| 2954 | <!-- </div> --> | |
| 2955 | <!-- </section> --> | |
| 2956 | <h2 class="operation-title"> | |
| 2957 | <span class="operation-name"> | |
| 2958 | <span class="operation-name">GET</span> | |
| ab0ee6a1 | 2959 | <span class="operation-path">/videos/categories</span> |
| 5e1c08eb C |
2960 | </span> |
| 2961 | </h2> | |
| 2962 | <div class="doc-row"> | |
| 2963 | <div class="doc-copy"> </div> | |
| 2964 | <div class="doc-examples"></div> | |
| 2965 | </div> | |
| 2966 | <div class="doc-row"> | |
| 2967 | <div class="doc-copy"> | |
| 2968 | <section class="swagger-responses"> | |
| 2969 | <div class="prop-row prop-group"> | |
| 2970 | <div class="prop-name"> | |
| 2971 | <div class="prop-title">200 OK</div> | |
| 2972 | <div class="prop-ref"></div> | |
| 2973 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 2974 | </div> | |
| 2975 | <div class="prop-value"> | |
| 2976 | <p>successful operation</p> | |
| 2977 | </div> | |
| 2978 | </div> | |
| 228e84aa C |
2979 | <div class="prop-row prop-inner"> |
| 2980 | <div class="prop-name">type</div> | |
| 2981 | <div class="prop-value"> | |
| 2982 | <span class="json-property-type">string[]</span> | |
| 2983 | <span class="json-property-range" title="Value limits"></span> | |
| 2984 | </div> | |
| 2985 | </div> | |
| 5e1c08eb C |
2986 | </section> |
| 2987 | </div> | |
| 2988 | <div class="doc-examples"> | |
| 2989 | <h5>Response Content-Types: | |
| 2990 | <span>application/json</span> | |
| 2991 | </h5> | |
| 2992 | <section> | |
| 2993 | <h5>Response Example | |
| 2994 | <span>(200 OK)</span> | |
| 2995 | </h5> | |
| 2996 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 2997 | <span class="hljs-string">"string"</span> | |
| 2998 | ] | |
| 2999 | </code></pre> | |
| 3000 | <!-- </div> --> | |
| 3001 | </section> | |
| 3002 | </div> | |
| 3003 | </div> | |
| 3004 | </div> | |
| ab0ee6a1 | 3005 | <div id="operation--videos-licences-get" class="operation panel" data-traverse-target="operation--videos-licences-get"> |
| 5e1c08eb C |
3006 | <!-- <section class="operation-tags row"> --> |
| 3007 | <!-- <div class="doc-copy"> --> | |
| 3008 | <div class="operation-tags"> | |
| 3009 | <a class="label" href="#tag-Video">Video</a> | |
| 3010 | <!----> | |
| 3011 | </div> | |
| 3012 | <!-- </div> --> | |
| 3013 | <!-- </section> --> | |
| 3014 | <h2 class="operation-title"> | |
| 3015 | <span class="operation-name"> | |
| 3016 | <span class="operation-name">GET</span> | |
| ab0ee6a1 | 3017 | <span class="operation-path">/videos/licences</span> |
| 5e1c08eb C |
3018 | </span> |
| 3019 | </h2> | |
| 3020 | <div class="doc-row"> | |
| 3021 | <div class="doc-copy"> </div> | |
| 3022 | <div class="doc-examples"></div> | |
| 3023 | </div> | |
| 3024 | <div class="doc-row"> | |
| 3025 | <div class="doc-copy"> | |
| 3026 | <section class="swagger-responses"> | |
| 3027 | <div class="prop-row prop-group"> | |
| 3028 | <div class="prop-name"> | |
| 3029 | <div class="prop-title">200 OK</div> | |
| 3030 | <div class="prop-ref"></div> | |
| 3031 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 3032 | </div> | |
| 3033 | <div class="prop-value"> | |
| 3034 | <p>successful operation</p> | |
| 3035 | </div> | |
| 3036 | </div> | |
| 228e84aa C |
3037 | <div class="prop-row prop-inner"> |
| 3038 | <div class="prop-name">type</div> | |
| 3039 | <div class="prop-value"> | |
| 3040 | <span class="json-property-type">string[]</span> | |
| 3041 | <span class="json-property-range" title="Value limits"></span> | |
| 3042 | </div> | |
| 3043 | </div> | |
| 5e1c08eb C |
3044 | </section> |
| 3045 | </div> | |
| 3046 | <div class="doc-examples"> | |
| 3047 | <h5>Response Content-Types: | |
| 3048 | <span>application/json</span> | |
| 3049 | </h5> | |
| 3050 | <section> | |
| 3051 | <h5>Response Example | |
| 3052 | <span>(200 OK)</span> | |
| 3053 | </h5> | |
| 3054 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 3055 | <span class="hljs-string">"string"</span> | |
| 3056 | ] | |
| 3057 | </code></pre> | |
| 3058 | <!-- </div> --> | |
| 3059 | </section> | |
| 3060 | </div> | |
| 3061 | </div> | |
| 3062 | </div> | |
| ab0ee6a1 | 3063 | <div id="operation--videos-languages-get" class="operation panel" data-traverse-target="operation--videos-languages-get"> |
| 5e1c08eb C |
3064 | <!-- <section class="operation-tags row"> --> |
| 3065 | <!-- <div class="doc-copy"> --> | |
| 3066 | <div class="operation-tags"> | |
| 3067 | <a class="label" href="#tag-Video">Video</a> | |
| 3068 | <!----> | |
| 3069 | </div> | |
| 3070 | <!-- </div> --> | |
| 3071 | <!-- </section> --> | |
| 3072 | <h2 class="operation-title"> | |
| 3073 | <span class="operation-name"> | |
| 3074 | <span class="operation-name">GET</span> | |
| ab0ee6a1 | 3075 | <span class="operation-path">/videos/languages</span> |
| 5e1c08eb C |
3076 | </span> |
| 3077 | </h2> | |
| 3078 | <div class="doc-row"> | |
| 3079 | <div class="doc-copy"> </div> | |
| 3080 | <div class="doc-examples"></div> | |
| 3081 | </div> | |
| 3082 | <div class="doc-row"> | |
| 3083 | <div class="doc-copy"> | |
| 3084 | <section class="swagger-responses"> | |
| 3085 | <div class="prop-row prop-group"> | |
| 3086 | <div class="prop-name"> | |
| 3087 | <div class="prop-title">200 OK</div> | |
| 3088 | <div class="prop-ref"></div> | |
| 3089 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 3090 | </div> | |
| 3091 | <div class="prop-value"> | |
| 3092 | <p>successful operation</p> | |
| 3093 | </div> | |
| 3094 | </div> | |
| 228e84aa C |
3095 | <div class="prop-row prop-inner"> |
| 3096 | <div class="prop-name">type</div> | |
| 3097 | <div class="prop-value"> | |
| 3098 | <span class="json-property-type">string[]</span> | |
| 3099 | <span class="json-property-range" title="Value limits"></span> | |
| 3100 | </div> | |
| 3101 | </div> | |
| 5e1c08eb C |
3102 | </section> |
| 3103 | </div> | |
| 3104 | <div class="doc-examples"> | |
| 3105 | <h5>Response Content-Types: | |
| 3106 | <span>application/json</span> | |
| 3107 | </h5> | |
| 3108 | <section> | |
| 3109 | <h5>Response Example | |
| 3110 | <span>(200 OK)</span> | |
| 3111 | </h5> | |
| 3112 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 3113 | <span class="hljs-string">"string"</span> | |
| 3114 | ] | |
| 3115 | </code></pre> | |
| 3116 | <!-- </div> --> | |
| 3117 | </section> | |
| 3118 | </div> | |
| 3119 | </div> | |
| 3120 | </div> | |
| ab0ee6a1 | 3121 | <div id="operation--videos-privacies-get" class="operation panel" data-traverse-target="operation--videos-privacies-get"> |
| 5e1c08eb C |
3122 | <!-- <section class="operation-tags row"> --> |
| 3123 | <!-- <div class="doc-copy"> --> | |
| 3124 | <div class="operation-tags"> | |
| 3125 | <a class="label" href="#tag-Video">Video</a> | |
| 3126 | <!----> | |
| 3127 | </div> | |
| 3128 | <!-- </div> --> | |
| 3129 | <!-- </section> --> | |
| 3130 | <h2 class="operation-title"> | |
| 3131 | <span class="operation-name"> | |
| 3132 | <span class="operation-name">GET</span> | |
| ab0ee6a1 | 3133 | <span class="operation-path">/videos/privacies</span> |
| 5e1c08eb C |
3134 | </span> |
| 3135 | </h2> | |
| 3136 | <div class="doc-row"> | |
| 3137 | <div class="doc-copy"> </div> | |
| 3138 | <div class="doc-examples"></div> | |
| 3139 | </div> | |
| 3140 | <div class="doc-row"> | |
| 3141 | <div class="doc-copy"> | |
| 3142 | <section class="swagger-responses"> | |
| 3143 | <div class="prop-row prop-group"> | |
| 3144 | <div class="prop-name"> | |
| 3145 | <div class="prop-title">200 OK</div> | |
| 3146 | <div class="prop-ref"></div> | |
| 3147 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 3148 | </div> | |
| 3149 | <div class="prop-value"> | |
| 3150 | <p>successful operation</p> | |
| 3151 | </div> | |
| 3152 | </div> | |
| 228e84aa C |
3153 | <div class="prop-row prop-inner"> |
| 3154 | <div class="prop-name">type</div> | |
| 3155 | <div class="prop-value"> | |
| 3156 | <span class="json-property-type">string[]</span> | |
| 3157 | <span class="json-property-range" title="Value limits"></span> | |
| 3158 | </div> | |
| 3159 | </div> | |
| 5e1c08eb C |
3160 | </section> |
| 3161 | </div> | |
| 3162 | <div class="doc-examples"> | |
| 3163 | <h5>Response Content-Types: | |
| 3164 | <span>application/json</span> | |
| 3165 | </h5> | |
| 3166 | <section> | |
| 3167 | <h5>Response Example | |
| 3168 | <span>(200 OK)</span> | |
| 3169 | </h5> | |
| 3170 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 3171 | <span class="hljs-string">"string"</span> | |
| 3172 | ] | |
| 3173 | </code></pre> | |
| 3174 | <!-- </div> --> | |
| 3175 | </section> | |
| 3176 | </div> | |
| 3177 | </div> | |
| 3178 | </div> | |
| ab0ee6a1 | 3179 | <div id="operation--videos-search-get" class="operation panel" data-traverse-target="operation--videos-search-get"> |
| 5e1c08eb C |
3180 | <!-- <section class="operation-tags row"> --> |
| 3181 | <!-- <div class="doc-copy"> --> | |
| 3182 | <div class="operation-tags"> | |
| 3183 | <a class="label" href="#tag-Video">Video</a> | |
| 3184 | <!----> | |
| 3185 | </div> | |
| 3186 | <!-- </div> --> | |
| 3187 | <!-- </section> --> | |
| 3188 | <h2 class="operation-title"> | |
| 3189 | <span class="operation-name"> | |
| 3190 | <span class="operation-name">GET</span> | |
| ab0ee6a1 | 3191 | <span class="operation-path">/videos/search</span> |
| 5e1c08eb C |
3192 | </span> |
| 3193 | </h2> | |
| 3194 | <div class="doc-row"> | |
| ab0ee6a1 C |
3195 | <div class="doc-copy"> |
| 3196 | <section class="swagger-request-params"> | |
| 3197 | <div class="prop-row prop-group"> | |
| 3198 | <div class="prop-name"> | |
| 3199 | <div class="prop-title">start</div> | |
| 228e84aa C |
3200 | <div class="prop-subtitle"> in query </div> |
| 3201 | <div class="prop-subtitle"> | |
| 3202 | <span class="json-property-type">number</span> | |
| 3203 | <span class="json-property-range" title="Value limits"></span> | |
| 3204 | </div> | |
| ab0ee6a1 C |
3205 | </div> |
| 3206 | <div class="prop-value"> | |
| 3207 | <p>starting page</p> | |
| 3208 | </div> | |
| 3209 | </div> | |
| ab0ee6a1 C |
3210 | <div class="prop-row prop-group"> |
| 3211 | <div class="prop-name"> | |
| 3212 | <div class="prop-title">stop</div> | |
| 228e84aa C |
3213 | <div class="prop-subtitle"> in query </div> |
| 3214 | <div class="prop-subtitle"> | |
| 3215 | <span class="json-property-type">number</span> | |
| 3216 | <span class="json-property-range" title="Value limits"></span> | |
| 3217 | </div> | |
| ab0ee6a1 C |
3218 | </div> |
| 3219 | <div class="prop-value"> | |
| f209b32a | 3220 | <p>stopping page</p> |
| ab0ee6a1 C |
3221 | </div> |
| 3222 | </div> | |
| ab0ee6a1 C |
3223 | <div class="prop-row prop-group"> |
| 3224 | <div class="prop-name"> | |
| 3225 | <div class="prop-title">sort</div> | |
| 228e84aa C |
3226 | <div class="prop-subtitle"> in query </div> |
| 3227 | <div class="prop-subtitle"> | |
| 3228 | <span class="json-property-type">number</span> | |
| 3229 | <span class="json-property-range" title="Value limits"></span> | |
| 3230 | </div> | |
| ab0ee6a1 C |
3231 | </div> |
| 3232 | <div class="prop-value"> | |
| 3233 | <p>sorting</p> | |
| 3234 | </div> | |
| 3235 | </div> | |
| ab0ee6a1 C |
3236 | </section> |
| 3237 | </div> | |
| 5e1c08eb C |
3238 | <div class="doc-examples"></div> |
| 3239 | </div> | |
| 3240 | <div class="doc-row"> | |
| 3241 | <div class="doc-copy"> | |
| 3242 | <section class="swagger-responses"> | |
| 3243 | <div class="prop-row prop-group"> | |
| 3244 | <div class="prop-name"> | |
| 3245 | <div class="prop-title">200 OK</div> | |
| 3246 | <div class="prop-ref"> | |
| 3247 | <span class="json-schema-ref-array"> | |
| 3248 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
| 3249 | </span> | |
| 3250 | </div> | |
| 3251 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 3252 | </div> | |
| 3253 | <div class="prop-value"> | |
| 3254 | <p>successful operation</p> | |
| 3255 | </div> | |
| 3256 | </div> | |
| 228e84aa C |
3257 | <div class="prop-row prop-inner"> |
| 3258 | <div class="prop-name">type</div> | |
| 3259 | <div class="prop-value"> | |
| 3260 | <span class="json-property-type"> | |
| 3261 | <span class="json-schema-ref-array"> | |
| 3262 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
| 3263 | </span> | |
| 3264 | </span> | |
| 3265 | <span class="json-property-range" title="Value limits"></span> | |
| 3266 | </div> | |
| 3267 | </div> | |
| 5e1c08eb C |
3268 | </section> |
| 3269 | </div> | |
| 3270 | <div class="doc-examples"> | |
| 3271 | <h5>Response Content-Types: | |
| 3272 | <span>application/json</span> | |
| 3273 | </h5> | |
| 3274 | <section> | |
| 3275 | <h5>Response Example | |
| 3276 | <span>(200 OK)</span> | |
| 3277 | </h5> | |
| 3278 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 3279 | { | |
| 3280 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 3281 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 5e1c08eb | 3282 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
| 61b66b36 | 3283 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb | 3284 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, |
| 5d00a3d7 C |
3285 | <span class="hljs-attr">"category"</span>: { |
| 3286 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 3287 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 3288 | }, | |
| 3289 | <span class="hljs-attr">"licence"</span>: { | |
| 3290 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 3291 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 3292 | }, | |
| 3293 | <span class="hljs-attr">"language"</span>: { | |
| 48dce1c9 | 3294 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
| 5d00a3d7 C |
3295 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
| 3296 | }, | |
| 61b66b36 | 3297 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb C |
3298 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
| 3299 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 3300 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 3301 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 5e1c08eb C |
3302 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
| 3303 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
| 3304 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
| 3305 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 3306 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 3307 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 61b66b36 C |
3308 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, |
| 3309 | <span class="hljs-attr">"account"</span>: { | |
| 3310 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 3311 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 3312 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 3313 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 3314 | <span class="hljs-attr">"avatar"</span>: { | |
| 3315 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 3316 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3317 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 3318 | } | |
| 3319 | } | |
| 5e1c08eb C |
3320 | } |
| 3321 | ] | |
| 3322 | </code></pre> | |
| 3323 | <!-- </div> --> | |
| 3324 | </section> | |
| 3325 | </div> | |
| 3326 | </div> | |
| 3327 | </div> | |
| ab0ee6a1 | 3328 | <div id="operation--videos--id--put" class="operation panel" data-traverse-target="operation--videos--id--put"> |
| 5e1c08eb C |
3329 | <!-- <section class="operation-tags row"> --> |
| 3330 | <!-- <div class="doc-copy"> --> | |
| 3331 | <div class="operation-tags"> | |
| 3332 | <a class="label" href="#tag-Video">Video</a> | |
| 3333 | <!----> | |
| 3334 | </div> | |
| 3335 | <!-- </div> --> | |
| 3336 | <!-- </section> --> | |
| 3337 | <h2 class="operation-title"> | |
| 3338 | <span class="operation-name"> | |
| 3339 | <span class="operation-name">PUT</span> | |
| ab0ee6a1 | 3340 | <span class="operation-path">/videos/{id}</span> |
| 5e1c08eb C |
3341 | </span> |
| 3342 | </h2> | |
| 3343 | <div class="doc-row"> | |
| 3344 | <div class="doc-copy"> | |
| 3345 | <section class="swagger-request-params"> | |
| 3346 | <div class="prop-row prop-group"> | |
| 3347 | <div class="prop-name"> | |
| 3348 | <div class="prop-title">id</div> | |
| 3349 | <span class="json-property-required"></span> | |
| 228e84aa C |
3350 | <div class="prop-subtitle"> in path </div> |
| 3351 | <div class="prop-subtitle"> | |
| 3352 | <span class="json-property-type">string</span> | |
| 3353 | <span class="json-property-range" title="Value limits"></span> | |
| 3354 | </div> | |
| 5e1c08eb C |
3355 | </div> |
| 3356 | <div class="prop-value"> | |
| 61b66b36 | 3357 | <p>The video id</p> |
| 5e1c08eb C |
3358 | </div> |
| 3359 | </div> | |
| 5e1c08eb C |
3360 | <div class="prop-row prop-group"> |
| 3361 | <div class="prop-name"> | |
| 61b66b36 | 3362 | <div class="prop-title">thumbnailfile</div> |
| 228e84aa C |
3363 | <div class="prop-subtitle"> in formData </div> |
| 3364 | <div class="prop-subtitle"> | |
| 3365 | <span class="json-property-type">file</span> | |
| 3366 | <span class="json-property-range" title="Value limits"></span> | |
| 3367 | </div> | |
| 5e1c08eb C |
3368 | </div> |
| 3369 | <div class="prop-value"> | |
| 61b66b36 | 3370 | <p>Video thumbnail file</p> |
| 5e1c08eb C |
3371 | </div> |
| 3372 | </div> | |
| 5e1c08eb C |
3373 | <div class="prop-row prop-group"> |
| 3374 | <div class="prop-name"> | |
| 61b66b36 | 3375 | <div class="prop-title">previewfile</div> |
| 228e84aa C |
3376 | <div class="prop-subtitle"> in formData </div> |
| 3377 | <div class="prop-subtitle"> | |
| 3378 | <span class="json-property-type">file</span> | |
| 3379 | <span class="json-property-range" title="Value limits"></span> | |
| 3380 | </div> | |
| 5e1c08eb C |
3381 | </div> |
| 3382 | <div class="prop-value"> | |
| 61b66b36 | 3383 | <p>Video preview file</p> |
| 5e1c08eb C |
3384 | </div> |
| 3385 | </div> | |
| 5e1c08eb C |
3386 | <div class="prop-row prop-group"> |
| 3387 | <div class="prop-name"> | |
| 61b66b36 | 3388 | <div class="prop-title">category</div> |
| 228e84aa C |
3389 | <div class="prop-subtitle"> in formData </div> |
| 3390 | <div class="prop-subtitle"> | |
| 3391 | <span class="json-property-type">number</span> | |
| 3392 | <span class="json-property-range" title="Value limits"></span> | |
| 3393 | </div> | |
| 5e1c08eb C |
3394 | </div> |
| 3395 | <div class="prop-value"> | |
| 61b66b36 | 3396 | <p>Video category</p> |
| 5e1c08eb C |
3397 | </div> |
| 3398 | </div> | |
| 5e1c08eb C |
3399 | <div class="prop-row prop-group"> |
| 3400 | <div class="prop-name"> | |
| 61b66b36 | 3401 | <div class="prop-title">licence</div> |
| 228e84aa C |
3402 | <div class="prop-subtitle"> in formData </div> |
| 3403 | <div class="prop-subtitle"> | |
| 3404 | <span class="json-property-type">number</span> | |
| 3405 | <span class="json-property-range" title="Value limits"></span> | |
| 3406 | </div> | |
| 5e1c08eb C |
3407 | </div> |
| 3408 | <div class="prop-value"> | |
| 61b66b36 | 3409 | <p>Video licence</p> |
| 5e1c08eb C |
3410 | </div> |
| 3411 | </div> | |
| 61b66b36 C |
3412 | <div class="prop-row prop-group"> |
| 3413 | <div class="prop-name"> | |
| 3414 | <div class="prop-title">language</div> | |
| 228e84aa C |
3415 | <div class="prop-subtitle"> in formData </div> |
| 3416 | <div class="prop-subtitle"> | |
| 48dce1c9 | 3417 | <span class="json-property-type">string</span> |
| 228e84aa C |
3418 | <span class="json-property-range" title="Value limits"></span> |
| 3419 | </div> | |
| 61b66b36 C |
3420 | </div> |
| 3421 | <div class="prop-value"> | |
| 3422 | <p>Video language</p> | |
| 3423 | </div> | |
| 3424 | </div> | |
| 61b66b36 C |
3425 | <div class="prop-row prop-group"> |
| 3426 | <div class="prop-name"> | |
| 3427 | <div class="prop-title">description</div> | |
| 228e84aa C |
3428 | <div class="prop-subtitle"> in formData </div> |
| 3429 | <div class="prop-subtitle"> | |
| 3430 | <span class="json-property-type">string</span> | |
| 3431 | <span class="json-property-range" title="Value limits"></span> | |
| 3432 | </div> | |
| 61b66b36 C |
3433 | </div> |
| 3434 | <div class="prop-value"> | |
| 3435 | <p>Video description</p> | |
| 3436 | </div> | |
| 3437 | </div> | |
| 61b66b36 C |
3438 | <div class="prop-row prop-group"> |
| 3439 | <div class="prop-name"> | |
| 3440 | <div class="prop-title">support</div> | |
| 228e84aa C |
3441 | <div class="prop-subtitle"> in formData </div> |
| 3442 | <div class="prop-subtitle"> | |
| 3443 | <span class="json-property-type">string</span> | |
| 3444 | <span class="json-property-range" title="Value limits"></span> | |
| 3445 | </div> | |
| 61b66b36 C |
3446 | </div> |
| 3447 | <div class="prop-value"> | |
| 3448 | <p>Text describing how to support the video uploader</p> | |
| 3449 | </div> | |
| 3450 | </div> | |
| 61b66b36 C |
3451 | <div class="prop-row prop-group"> |
| 3452 | <div class="prop-name"> | |
| 3453 | <div class="prop-title">nsfw</div> | |
| 228e84aa C |
3454 | <div class="prop-subtitle"> in formData </div> |
| 3455 | <div class="prop-subtitle"> | |
| 3456 | <span class="json-property-type">boolean</span> | |
| 3457 | <span class="json-property-range" title="Value limits"></span> | |
| 3458 | </div> | |
| 61b66b36 C |
3459 | </div> |
| 3460 | <div class="prop-value"> | |
| 3461 | <p>Whether or not this video contains sensitive content</p> | |
| 3462 | </div> | |
| 3463 | </div> | |
| 61b66b36 C |
3464 | <div class="prop-row prop-group"> |
| 3465 | <div class="prop-name"> | |
| 3466 | <div class="prop-title">name</div> | |
| 228e84aa C |
3467 | <div class="prop-subtitle"> in formData </div> |
| 3468 | <div class="prop-subtitle"> | |
| 3469 | <span class="json-property-type">string</span> | |
| 3470 | <span class="json-property-range" title="Value limits"></span> | |
| 3471 | </div> | |
| 61b66b36 C |
3472 | </div> |
| 3473 | <div class="prop-value"> | |
| 3474 | <p>Video name</p> | |
| 3475 | </div> | |
| 3476 | </div> | |
| 61b66b36 C |
3477 | <div class="prop-row prop-group"> |
| 3478 | <div class="prop-name"> | |
| 3479 | <div class="prop-title">tags</div> | |
| 228e84aa C |
3480 | <div class="prop-subtitle"> in formData </div> |
| 3481 | <div class="prop-subtitle"> | |
| 3482 | <span class="json-property-type">string[]</span> | |
| 3483 | <span class="json-property-range" title="Value limits"></span> | |
| 3484 | </div> | |
| 61b66b36 C |
3485 | </div> |
| 3486 | <div class="prop-value"> | |
| 3487 | <p>Video tags</p> | |
| 3488 | </div> | |
| 3489 | </div> | |
| 61b66b36 C |
3490 | <div class="prop-row prop-group"> |
| 3491 | <div class="prop-name"> | |
| 3492 | <div class="prop-title">commentsEnabled</div> | |
| 228e84aa C |
3493 | <div class="prop-subtitle"> in formData </div> |
| 3494 | <div class="prop-subtitle"> | |
| 3495 | <span class="json-property-type">boolean</span> | |
| 3496 | <span class="json-property-range" title="Value limits"></span> | |
| 3497 | </div> | |
| 61b66b36 C |
3498 | </div> |
| 3499 | <div class="prop-value"> | |
| 3500 | <p>Enable or disable comments for this video</p> | |
| 3501 | </div> | |
| 3502 | </div> | |
| 61b66b36 C |
3503 | <div class="prop-row prop-group"> |
| 3504 | <div class="prop-name"> | |
| 3505 | <div class="prop-title">privacy</div> | |
| 228e84aa C |
3506 | <div class="prop-subtitle"> in formData </div> |
| 3507 | <div class="prop-subtitle"> | |
| 3508 | <span class="json-property-type">string</span> | |
| 3509 | <span class="json-property-enum" title="Possible values"> | |
| 3510 | <span class="json-property-enum-item">Public</span>, | |
| 3511 | <span class="json-property-enum-item">Unlisted</span> | |
| 3512 | </span> | |
| 3513 | <span class="json-property-range" title="Value limits"></span> | |
| 3514 | </div> | |
| 61b66b36 C |
3515 | </div> |
| 3516 | <div class="prop-value"> | |
| 3517 | <p>Video privacy</p> | |
| 3518 | </div> | |
| 3519 | </div> | |
| 61b66b36 C |
3520 | </section> |
| 3521 | </div> | |
| 3522 | <div class="doc-examples"></div> | |
| 3523 | </div> | |
| 3524 | <div class="doc-row"> | |
| 3525 | <div class="doc-copy"> | |
| 3526 | <section class="swagger-responses"> | |
| 3527 | <div class="prop-row prop-group"> | |
| 3528 | <div class="prop-name"> | |
| 3529 | <div class="prop-title">200 OK</div> | |
| 3530 | <div class="prop-ref"> | |
| 3531 | <span class=""> | |
| 3532 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
| 3533 | </span> | |
| 3534 | </div> | |
| 3535 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 3536 | </div> | |
| 3537 | <div class="prop-value"> | |
| 3538 | <p>successful operation</p> | |
| 3539 | </div> | |
| 3540 | </div> | |
| 3541 | </section> | |
| 3542 | </div> | |
| 3543 | <div class="doc-examples"> | |
| 3544 | <h5>Response Content-Types: | |
| 3545 | <span>application/json</span> | |
| 3546 | </h5> | |
| 3547 | <section> | |
| 3548 | <h5>Response Example | |
| 3549 | <span>(200 OK)</span> | |
| 3550 | </h5> | |
| 3551 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 3552 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 3553 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 3554 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3555 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3556 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3557 | <span class="hljs-attr">"category"</span>: { | |
| 3558 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 3559 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 3560 | }, | |
| 3561 | <span class="hljs-attr">"licence"</span>: { | |
| 3562 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 3563 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 3564 | }, | |
| 3565 | <span class="hljs-attr">"language"</span>: { | |
| 48dce1c9 | 3566 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
| 61b66b36 C |
3567 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
| 3568 | }, | |
| 3569 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | |
| 3570 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 3571 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 3572 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 3573 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 3574 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
| 3575 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
| 3576 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
| 3577 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 3578 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 3579 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 3580 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | |
| 3581 | <span class="hljs-attr">"account"</span>: { | |
| 3582 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 3583 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 3584 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 3585 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 3586 | <span class="hljs-attr">"avatar"</span>: { | |
| 3587 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 3588 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3589 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 3590 | } | |
| 3591 | } | |
| 3592 | } | |
| 3593 | </code></pre> | |
| 3594 | <!-- </div> --> | |
| 3595 | </section> | |
| 3596 | </div> | |
| 3597 | </div> | |
| 94ff4c23 C |
3598 | <div class="doc-row"> |
| 3599 | <div class="doc-copy"> | |
| 3600 | <section class="swagger-request-security"> | |
| 3601 | <table class="table"> | |
| 3602 | <thead> | |
| 3603 | <tr> | |
| 3604 | <th class="swagger-request-security-schema"></th> | |
| 3605 | <th class="swagger-request-security-scopes"></th> | |
| 3606 | </tr> | |
| 3607 | </thead> | |
| 3608 | <tbody> | |
| 3609 | <tr> | |
| 3610 | <td> | |
| 3611 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 3612 | </td> | |
| 3613 | <td> </td> | |
| 3614 | </tr> | |
| 3615 | </tbody> | |
| 3616 | </table> | |
| 3617 | </section> | |
| 3618 | </div> | |
| 3619 | </div> | |
| 61b66b36 C |
3620 | </div> |
| 3621 | <div id="operation--videos--id--get" class="operation panel" data-traverse-target="operation--videos--id--get"> | |
| 3622 | <!-- <section class="operation-tags row"> --> | |
| 3623 | <!-- <div class="doc-copy"> --> | |
| 3624 | <div class="operation-tags"> | |
| 3625 | <a class="label" href="#tag-Video">Video</a> | |
| 3626 | <!----> | |
| 3627 | </div> | |
| 3628 | <!-- </div> --> | |
| 3629 | <!-- </section> --> | |
| 3630 | <h2 class="operation-title"> | |
| 3631 | <span class="operation-name"> | |
| 3632 | <span class="operation-name">GET</span> | |
| 3633 | <span class="operation-path">/videos/{id}</span> | |
| 3634 | </span> | |
| 3635 | </h2> | |
| 3636 | <div class="doc-row"> | |
| 3637 | <div class="doc-copy"> | |
| 3638 | <section class="swagger-request-params"> | |
| 3639 | <div class="prop-row prop-group"> | |
| 3640 | <div class="prop-name"> | |
| 3641 | <div class="prop-title">id</div> | |
| 3642 | <span class="json-property-required"></span> | |
| 228e84aa C |
3643 | <div class="prop-subtitle"> in path </div> |
| 3644 | <div class="prop-subtitle"> | |
| 3645 | <span class="json-property-type">string</span> | |
| 3646 | <span class="json-property-range" title="Value limits"></span> | |
| 3647 | </div> | |
| 61b66b36 C |
3648 | </div> |
| 3649 | <div class="prop-value"> | |
| 3650 | <p>The video id </p> | |
| 3651 | </div> | |
| 3652 | </div> | |
| 61b66b36 C |
3653 | </section> |
| 3654 | </div> | |
| 3655 | <div class="doc-examples"></div> | |
| 3656 | </div> | |
| 3657 | <div class="doc-row"> | |
| 3658 | <div class="doc-copy"> | |
| 3659 | <section class="swagger-responses"> | |
| 3660 | <div class="prop-row prop-group"> | |
| 3661 | <div class="prop-name"> | |
| 3662 | <div class="prop-title">200 OK</div> | |
| 3663 | <div class="prop-ref"> | |
| 3664 | <span class=""> | |
| 3665 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
| 3666 | </span> | |
| 3667 | </div> | |
| 3668 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 3669 | </div> | |
| 3670 | <div class="prop-value"> | |
| 3671 | <p>successful operation</p> | |
| 3672 | </div> | |
| 3673 | </div> | |
| 3674 | </section> | |
| 3675 | </div> | |
| 3676 | <div class="doc-examples"> | |
| 3677 | <h5>Response Content-Types: | |
| 3678 | <span>application/json</span> | |
| 3679 | </h5> | |
| 3680 | <section> | |
| 3681 | <h5>Response Example | |
| 3682 | <span>(200 OK)</span> | |
| 3683 | </h5> | |
| 3684 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 3685 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 3686 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 3687 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3688 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3689 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3690 | <span class="hljs-attr">"category"</span>: { | |
| 3691 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 3692 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 3693 | }, | |
| 3694 | <span class="hljs-attr">"licence"</span>: { | |
| 3695 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 3696 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 3697 | }, | |
| 3698 | <span class="hljs-attr">"language"</span>: { | |
| 48dce1c9 | 3699 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
| 61b66b36 C |
3700 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
| 3701 | }, | |
| 3702 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | |
| 3703 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 3704 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 3705 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 3706 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 3707 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
| 3708 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
| 3709 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
| 3710 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 3711 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 3712 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 3713 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | |
| 3714 | <span class="hljs-attr">"account"</span>: { | |
| 3715 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 3716 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 3717 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 3718 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 3719 | <span class="hljs-attr">"avatar"</span>: { | |
| 3720 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 3721 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3722 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 3723 | } | |
| 3724 | } | |
| 3725 | } | |
| 3726 | </code></pre> | |
| 3727 | <!-- </div> --> | |
| 3728 | </section> | |
| 3729 | </div> | |
| 3730 | </div> | |
| 3731 | </div> | |
| 3732 | <div id="operation--videos--id--delete" class="operation panel" data-traverse-target="operation--videos--id--delete"> | |
| 3733 | <!-- <section class="operation-tags row"> --> | |
| 3734 | <!-- <div class="doc-copy"> --> | |
| 3735 | <div class="operation-tags"> | |
| 3736 | <a class="label" href="#tag-Video">Video</a> | |
| 3737 | <!----> | |
| 3738 | </div> | |
| 3739 | <!-- </div> --> | |
| 3740 | <!-- </section> --> | |
| 3741 | <h2 class="operation-title"> | |
| 3742 | <span class="operation-name"> | |
| 3743 | <span class="operation-name">DELETE</span> | |
| 3744 | <span class="operation-path">/videos/{id}</span> | |
| 3745 | </span> | |
| 3746 | </h2> | |
| 3747 | <div class="doc-row"> | |
| 3748 | <div class="doc-copy"> | |
| 3749 | <section class="swagger-request-params"> | |
| 3750 | <div class="prop-row prop-group"> | |
| 3751 | <div class="prop-name"> | |
| 3752 | <div class="prop-title">id</div> | |
| 3753 | <span class="json-property-required"></span> | |
| 228e84aa C |
3754 | <div class="prop-subtitle"> in path </div> |
| 3755 | <div class="prop-subtitle"> | |
| 3756 | <span class="json-property-type">string</span> | |
| 3757 | <span class="json-property-range" title="Value limits"></span> | |
| 3758 | </div> | |
| 61b66b36 C |
3759 | </div> |
| 3760 | <div class="prop-value"> | |
| 3761 | <p>The video id </p> | |
| 3762 | </div> | |
| 3763 | </div> | |
| 61b66b36 C |
3764 | </section> |
| 3765 | </div> | |
| 3766 | <div class="doc-examples"></div> | |
| 3767 | </div> | |
| 3768 | <div class="doc-row"> | |
| 3769 | <div class="doc-copy"> | |
| 3770 | <section class="swagger-responses"> | |
| 3771 | <div class="prop-row prop-group"> | |
| 3772 | <div class="prop-name"> | |
| 3773 | <div class="prop-title">204 No Content</div> | |
| 3774 | </div> | |
| 3775 | <div class="prop-value"> | |
| 3776 | <p>successful operation</p> | |
| 3777 | </div> | |
| 3778 | </div> | |
| 3779 | </section> | |
| 3780 | </div> | |
| 3781 | <div class="doc-examples"> | |
| 3782 | <h5>Response Content-Types: | |
| 3783 | <span>application/json</span> | |
| 3784 | </h5> | |
| 3785 | </div> | |
| 3786 | </div> | |
| 94ff4c23 C |
3787 | <div class="doc-row"> |
| 3788 | <div class="doc-copy"> | |
| 3789 | <section class="swagger-request-security"> | |
| 3790 | <table class="table"> | |
| 3791 | <thead> | |
| 3792 | <tr> | |
| 3793 | <th class="swagger-request-security-schema"></th> | |
| 3794 | <th class="swagger-request-security-scopes"></th> | |
| 3795 | </tr> | |
| 3796 | </thead> | |
| 3797 | <tbody> | |
| 3798 | <tr> | |
| 3799 | <td> | |
| 3800 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 3801 | </td> | |
| 3802 | <td> </td> | |
| 3803 | </tr> | |
| 3804 | </tbody> | |
| 3805 | </table> | |
| 3806 | </section> | |
| 3807 | </div> | |
| 3808 | </div> | |
| 61b66b36 C |
3809 | </div> |
| 3810 | <div id="operation--videos--id--description-get" class="operation panel" data-traverse-target="operation--videos--id--description-get"> | |
| 3811 | <!-- <section class="operation-tags row"> --> | |
| 3812 | <!-- <div class="doc-copy"> --> | |
| 3813 | <div class="operation-tags"> | |
| 3814 | <a class="label" href="#tag-Video">Video</a> | |
| 3815 | <!----> | |
| 3816 | </div> | |
| 3817 | <!-- </div> --> | |
| 3818 | <!-- </section> --> | |
| 3819 | <h2 class="operation-title"> | |
| 3820 | <span class="operation-name"> | |
| 3821 | <span class="operation-name">GET</span> | |
| 3822 | <span class="operation-path">/videos/{id}/description</span> | |
| 3823 | </span> | |
| 3824 | </h2> | |
| 3825 | <div class="doc-row"> | |
| 3826 | <div class="doc-copy"> | |
| 3827 | <section class="swagger-request-params"> | |
| 3828 | <div class="prop-row prop-group"> | |
| 3829 | <div class="prop-name"> | |
| 3830 | <div class="prop-title">id</div> | |
| 3831 | <span class="json-property-required"></span> | |
| 228e84aa C |
3832 | <div class="prop-subtitle"> in path </div> |
| 3833 | <div class="prop-subtitle"> | |
| 3834 | <span class="json-property-type">string</span> | |
| 3835 | <span class="json-property-range" title="Value limits"></span> | |
| 3836 | </div> | |
| 61b66b36 C |
3837 | </div> |
| 3838 | <div class="prop-value"> | |
| 3839 | <p>The video id </p> | |
| 3840 | </div> | |
| 3841 | </div> | |
| 61b66b36 C |
3842 | </section> |
| 3843 | </div> | |
| 3844 | <div class="doc-examples"></div> | |
| 3845 | </div> | |
| 3846 | <div class="doc-row"> | |
| 3847 | <div class="doc-copy"> | |
| 3848 | <section class="swagger-responses"> | |
| 3849 | <div class="prop-row prop-group"> | |
| 3850 | <div class="prop-name"> | |
| 3851 | <div class="prop-title">200 OK</div> | |
| 3852 | <div class="prop-ref"></div> | |
| 3853 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 3854 | </div> | |
| 3855 | <div class="prop-value"> | |
| 3856 | <p>successful operation</p> | |
| 3857 | </div> | |
| 3858 | </div> | |
| 228e84aa C |
3859 | <div class="prop-row prop-inner"> |
| 3860 | <div class="prop-name">type</div> | |
| 3861 | <div class="prop-value"> | |
| 3862 | <span class="json-property-type">string</span> | |
| 3863 | <span class="json-property-range" title="Value limits"></span> | |
| 3864 | </div> | |
| 3865 | </div> | |
| 61b66b36 C |
3866 | </section> |
| 3867 | </div> | |
| 3868 | <div class="doc-examples"> | |
| 3869 | <h5>Response Content-Types: | |
| 3870 | <span>application/json</span> | |
| 3871 | </h5> | |
| 3872 | <section> | |
| 3873 | <h5>Response Example | |
| 3874 | <span>(200 OK)</span> | |
| 3875 | </h5> | |
| 3876 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">"string"</span> | |
| 3877 | </code></pre> | |
| 3878 | <!-- </div> --> | |
| 3879 | </section> | |
| 3880 | </div> | |
| 3881 | </div> | |
| 3882 | </div> | |
| 3883 | <div id="operation--videos--id--views-post" class="operation panel" data-traverse-target="operation--videos--id--views-post"> | |
| 3884 | <!-- <section class="operation-tags row"> --> | |
| 3885 | <!-- <div class="doc-copy"> --> | |
| 3886 | <div class="operation-tags"> | |
| 3887 | <a class="label" href="#tag-Video">Video</a> | |
| 3888 | <!----> | |
| 3889 | </div> | |
| 3890 | <!-- </div> --> | |
| 3891 | <!-- </section> --> | |
| 3892 | <h2 class="operation-title"> | |
| 3893 | <span class="operation-name"> | |
| 3894 | <span class="operation-name">POST</span> | |
| 3895 | <span class="operation-path">/videos/{id}/views</span> | |
| 3896 | </span> | |
| 3897 | </h2> | |
| 3898 | <div class="doc-row"> | |
| 3899 | <div class="doc-copy"> | |
| 3900 | <section class="swagger-request-params"> | |
| 3901 | <div class="prop-row prop-group"> | |
| 3902 | <div class="prop-name"> | |
| 3903 | <div class="prop-title">id</div> | |
| 3904 | <span class="json-property-required"></span> | |
| 228e84aa C |
3905 | <div class="prop-subtitle"> in path </div> |
| 3906 | <div class="prop-subtitle"> | |
| 3907 | <span class="json-property-type">string</span> | |
| 3908 | <span class="json-property-range" title="Value limits"></span> | |
| 3909 | </div> | |
| 61b66b36 C |
3910 | </div> |
| 3911 | <div class="prop-value"> | |
| 3912 | <p>The video id </p> | |
| 3913 | </div> | |
| 3914 | </div> | |
| 5e1c08eb C |
3915 | </section> |
| 3916 | </div> | |
| 3917 | <div class="doc-examples"></div> | |
| 3918 | </div> | |
| 3919 | <div class="doc-row"> | |
| 3920 | <div class="doc-copy"> | |
| 3921 | <section class="swagger-responses"> | |
| 3922 | <div class="prop-row prop-group"> | |
| 3923 | <div class="prop-name"> | |
| 3924 | <div class="prop-title">204 No Content</div> | |
| 3925 | </div> | |
| 3926 | <div class="prop-value"> | |
| 3927 | <p>successful operation</p> | |
| 3928 | </div> | |
| 3929 | </div> | |
| 3930 | </section> | |
| 3931 | </div> | |
| 3932 | <div class="doc-examples"> | |
| 3933 | <h5>Response Content-Types: | |
| 3934 | <span>application/json</span> | |
| 3935 | </h5> | |
| 3936 | </div> | |
| 3937 | </div> | |
| 3938 | </div> | |
| 61b66b36 | 3939 | <div id="operation--videos-upload-post" class="operation panel" data-traverse-target="operation--videos-upload-post"> |
| 5e1c08eb C |
3940 | <!-- <section class="operation-tags row"> --> |
| 3941 | <!-- <div class="doc-copy"> --> | |
| 3942 | <div class="operation-tags"> | |
| 3943 | <a class="label" href="#tag-Video">Video</a> | |
| 3944 | <!----> | |
| 3945 | </div> | |
| 3946 | <!-- </div> --> | |
| 3947 | <!-- </section> --> | |
| 3948 | <h2 class="operation-title"> | |
| 3949 | <span class="operation-name"> | |
| 61b66b36 C |
3950 | <span class="operation-name">POST</span> |
| 3951 | <span class="operation-path">/videos/upload</span> | |
| 5e1c08eb C |
3952 | </span> |
| 3953 | </h2> | |
| 3954 | <div class="doc-row"> | |
| 3955 | <div class="doc-copy"> | |
| 3956 | <section class="swagger-request-params"> | |
| 3957 | <div class="prop-row prop-group"> | |
| 3958 | <div class="prop-name"> | |
| 61b66b36 C |
3959 | <div class="prop-title">videofile</div> |
| 3960 | <span class="json-property-required"></span> | |
| 228e84aa C |
3961 | <div class="prop-subtitle"> in formData </div> |
| 3962 | <div class="prop-subtitle"> | |
| 3963 | <span class="json-property-type">file</span> | |
| 3964 | <span class="json-property-range" title="Value limits"></span> | |
| 3965 | </div> | |
| 61b66b36 C |
3966 | </div> |
| 3967 | <div class="prop-value"> | |
| 3968 | <p>Video file</p> | |
| 3969 | </div> | |
| 3970 | </div> | |
| 61b66b36 C |
3971 | <div class="prop-row prop-group"> |
| 3972 | <div class="prop-name"> | |
| 3973 | <div class="prop-title">thumbnailfile</div> | |
| 3974 | <span class="json-property-required"></span> | |
| 228e84aa C |
3975 | <div class="prop-subtitle"> in formData </div> |
| 3976 | <div class="prop-subtitle"> | |
| 3977 | <span class="json-property-type">file</span> | |
| 3978 | <span class="json-property-range" title="Value limits"></span> | |
| 3979 | </div> | |
| 61b66b36 C |
3980 | </div> |
| 3981 | <div class="prop-value"> | |
| 3982 | <p>Video thumbnail file</p> | |
| 3983 | </div> | |
| 3984 | </div> | |
| 61b66b36 C |
3985 | <div class="prop-row prop-group"> |
| 3986 | <div class="prop-name"> | |
| 3987 | <div class="prop-title">previewfile</div> | |
| 3988 | <span class="json-property-required"></span> | |
| 228e84aa C |
3989 | <div class="prop-subtitle"> in formData </div> |
| 3990 | <div class="prop-subtitle"> | |
| 3991 | <span class="json-property-type">file</span> | |
| 3992 | <span class="json-property-range" title="Value limits"></span> | |
| 3993 | </div> | |
| 61b66b36 C |
3994 | </div> |
| 3995 | <div class="prop-value"> | |
| 3996 | <p>Video preview file</p> | |
| 3997 | </div> | |
| 3998 | </div> | |
| 61b66b36 C |
3999 | <div class="prop-row prop-group"> |
| 4000 | <div class="prop-name"> | |
| 4001 | <div class="prop-title">category</div> | |
| 228e84aa C |
4002 | <div class="prop-subtitle"> in formData </div> |
| 4003 | <div class="prop-subtitle"> | |
| 4004 | <span class="json-property-type">number</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 category</p> | |
| 4010 | </div> | |
| 4011 | </div> | |
| 61b66b36 C |
4012 | <div class="prop-row prop-group"> |
| 4013 | <div class="prop-name"> | |
| 4014 | <div class="prop-title">licence</div> | |
| 228e84aa C |
4015 | <div class="prop-subtitle"> in formData </div> |
| 4016 | <div class="prop-subtitle"> | |
| 4017 | <span class="json-property-type">number</span> | |
| 4018 | <span class="json-property-range" title="Value limits"></span> | |
| 4019 | </div> | |
| 61b66b36 C |
4020 | </div> |
| 4021 | <div class="prop-value"> | |
| 4022 | <p>Video licence</p> | |
| 4023 | </div> | |
| 4024 | </div> | |
| 61b66b36 C |
4025 | <div class="prop-row prop-group"> |
| 4026 | <div class="prop-name"> | |
| 4027 | <div class="prop-title">language</div> | |
| 228e84aa C |
4028 | <div class="prop-subtitle"> in formData </div> |
| 4029 | <div class="prop-subtitle"> | |
| 48dce1c9 | 4030 | <span class="json-property-type">string</span> |
| 228e84aa C |
4031 | <span class="json-property-range" title="Value limits"></span> |
| 4032 | </div> | |
| 61b66b36 C |
4033 | </div> |
| 4034 | <div class="prop-value"> | |
| 4035 | <p>Video language</p> | |
| 4036 | </div> | |
| 4037 | </div> | |
| 61b66b36 C |
4038 | <div class="prop-row prop-group"> |
| 4039 | <div class="prop-name"> | |
| 4040 | <div class="prop-title">description</div> | |
| 228e84aa C |
4041 | <div class="prop-subtitle"> in formData </div> |
| 4042 | <div class="prop-subtitle"> | |
| 4043 | <span class="json-property-type">string</span> | |
| 4044 | <span class="json-property-range" title="Value limits"></span> | |
| 4045 | </div> | |
| 61b66b36 C |
4046 | </div> |
| 4047 | <div class="prop-value"> | |
| 4048 | <p>Video description</p> | |
| 4049 | </div> | |
| 4050 | </div> | |
| 61b66b36 C |
4051 | <div class="prop-row prop-group"> |
| 4052 | <div class="prop-name"> | |
| 4053 | <div class="prop-title">support</div> | |
| 228e84aa C |
4054 | <div class="prop-subtitle"> in formData </div> |
| 4055 | <div class="prop-subtitle"> | |
| 4056 | <span class="json-property-type">string</span> | |
| 4057 | <span class="json-property-range" title="Value limits"></span> | |
| 4058 | </div> | |
| 61b66b36 C |
4059 | </div> |
| 4060 | <div class="prop-value"> | |
| 4061 | <p>Text describing how to support the video uploader</p> | |
| 4062 | </div> | |
| 4063 | </div> | |
| 61b66b36 C |
4064 | <div class="prop-row prop-group"> |
| 4065 | <div class="prop-name"> | |
| 4066 | <div class="prop-title">channelId</div> | |
| 5e1c08eb | 4067 | <span class="json-property-required"></span> |
| 228e84aa C |
4068 | <div class="prop-subtitle"> in formData </div> |
| 4069 | <div class="prop-subtitle"> | |
| 4070 | <span class="json-property-type">number</span> | |
| 4071 | <span class="json-property-range" title="Value limits"></span> | |
| 4072 | </div> | |
| 5e1c08eb C |
4073 | </div> |
| 4074 | <div class="prop-value"> | |
| 61b66b36 | 4075 | <p>Channel id that will contain this video</p> |
| 5e1c08eb C |
4076 | </div> |
| 4077 | </div> | |
| 5e1c08eb C |
4078 | <div class="prop-row prop-group"> |
| 4079 | <div class="prop-name"> | |
| 61b66b36 C |
4080 | <div class="prop-title">nsfw</div> |
| 4081 | <span class="json-property-required"></span> | |
| 228e84aa C |
4082 | <div class="prop-subtitle"> in formData </div> |
| 4083 | <div class="prop-subtitle"> | |
| 4084 | <span class="json-property-type">boolean</span> | |
| 4085 | <span class="json-property-range" title="Value limits"></span> | |
| 4086 | </div> | |
| 5e1c08eb C |
4087 | </div> |
| 4088 | <div class="prop-value"> | |
| 61b66b36 | 4089 | <p>Whether or not this video contains sensitive content</p> |
| 5e1c08eb C |
4090 | </div> |
| 4091 | </div> | |
| 5e1c08eb C |
4092 | <div class="prop-row prop-group"> |
| 4093 | <div class="prop-name"> | |
| 61b66b36 | 4094 | <div class="prop-title">name</div> |
| 5e1c08eb | 4095 | <span class="json-property-required"></span> |
| 228e84aa C |
4096 | <div class="prop-subtitle"> in formData </div> |
| 4097 | <div class="prop-subtitle"> | |
| 4098 | <span class="json-property-type">string</span> | |
| 4099 | <span class="json-property-range" title="Value limits"></span> | |
| 4100 | </div> | |
| 5e1c08eb C |
4101 | </div> |
| 4102 | <div class="prop-value"> | |
| 61b66b36 | 4103 | <p>Video name</p> |
| 5e1c08eb C |
4104 | </div> |
| 4105 | </div> | |
| 5e1c08eb C |
4106 | <div class="prop-row prop-group"> |
| 4107 | <div class="prop-name"> | |
| 61b66b36 | 4108 | <div class="prop-title">tags</div> |
| 228e84aa C |
4109 | <div class="prop-subtitle"> in formData </div> |
| 4110 | <div class="prop-subtitle"> | |
| 4111 | <span class="json-property-type">string[]</span> | |
| 4112 | <span class="json-property-range" title="Value limits"></span> | |
| 4113 | </div> | |
| 5e1c08eb C |
4114 | </div> |
| 4115 | <div class="prop-value"> | |
| 61b66b36 | 4116 | <p>Video tags</p> |
| 5e1c08eb C |
4117 | </div> |
| 4118 | </div> | |
| 5e1c08eb C |
4119 | <div class="prop-row prop-group"> |
| 4120 | <div class="prop-name"> | |
| 61b66b36 | 4121 | <div class="prop-title">commentsEnabled</div> |
| 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>Enable or disable comments for this video</p> |
| 5e1c08eb C |
4130 | </div> |
| 4131 | </div> | |
| 61b66b36 C |
4132 | <div class="prop-row prop-group"> |
| 4133 | <div class="prop-name"> | |
| 4134 | <div class="prop-title">privacy</div> | |
| 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-enum" title="Possible values"> | |
| 4140 | <span class="json-property-enum-item">Public</span>, | |
| 4141 | <span class="json-property-enum-item">Unlisted</span>, | |
| 4142 | <span class="json-property-enum-item">Private</span> | |
| 4143 | </span> | |
| 4144 | <span class="json-property-range" title="Value limits"></span> | |
| 4145 | </div> | |
| 61b66b36 C |
4146 | </div> |
| 4147 | <div class="prop-value"> | |
| 4148 | <p>Video privacy</p> | |
| 4149 | </div> | |
| 4150 | </div> | |
| 5e1c08eb C |
4151 | </section> |
| 4152 | </div> | |
| 4153 | <div class="doc-examples"></div> | |
| 4154 | </div> | |
| 4155 | <div class="doc-row"> | |
| 4156 | <div class="doc-copy"> | |
| 4157 | <section class="swagger-responses"> | |
| 4158 | <div class="prop-row prop-group"> | |
| 4159 | <div class="prop-name"> | |
| 4160 | <div class="prop-title">200 OK</div> | |
| 4161 | <div class="prop-ref"> | |
| 4162 | <span class=""> | |
| 4163 | <a class="json-schema-ref" href="#/definitions/VideoUploadResponse">VideoUploadResponse</a> | |
| 4164 | </span> | |
| 4165 | </div> | |
| 4166 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 4167 | </div> | |
| 4168 | <div class="prop-value"> | |
| 4169 | <p>successful operation</p> | |
| 4170 | </div> | |
| 4171 | </div> | |
| 4172 | </section> | |
| 4173 | </div> | |
| 4174 | <div class="doc-examples"> | |
| 4175 | <h5>Response Content-Types: | |
| 4176 | <span>application/json</span> | |
| 4177 | </h5> | |
| 4178 | <section> | |
| 4179 | <h5>Response Example | |
| 4180 | <span>(200 OK)</span> | |
| 4181 | </h5> | |
| 4182 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 61b66b36 C |
4183 | <span class="hljs-attr">"video"</span>: { |
| 4184 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 4185 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
| 4186 | } | |
| 5e1c08eb C |
4187 | } |
| 4188 | </code></pre> | |
| 4189 | <!-- </div> --> | |
| 4190 | </section> | |
| 4191 | </div> | |
| 4192 | </div> | |
| 94ff4c23 C |
4193 | <div class="doc-row"> |
| 4194 | <div class="doc-copy"> | |
| 4195 | <section class="swagger-request-security"> | |
| 4196 | <table class="table"> | |
| 4197 | <thead> | |
| 4198 | <tr> | |
| 4199 | <th class="swagger-request-security-schema"></th> | |
| 4200 | <th class="swagger-request-security-scopes"></th> | |
| 4201 | </tr> | |
| 4202 | </thead> | |
| 4203 | <tbody> | |
| 4204 | <tr> | |
| 4205 | <td> | |
| 4206 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 4207 | </td> | |
| 4208 | <td> </td> | |
| 4209 | </tr> | |
| 4210 | </tbody> | |
| 4211 | </table> | |
| 4212 | </section> | |
| 4213 | </div> | |
| 4214 | </div> | |
| 5e1c08eb C |
4215 | </div> |
| 4216 | <h1 id="tag-VideoAbuse" class="swagger-summary-tag" data-traverse-target="tag-VideoAbuse">VideoAbuse</h1> | |
| ab0ee6a1 | 4217 | <div id="operation--videos-abuse-get" class="operation panel" data-traverse-target="operation--videos-abuse-get"> |
| 5e1c08eb C |
4218 | <!-- <section class="operation-tags row"> --> |
| 4219 | <!-- <div class="doc-copy"> --> | |
| 4220 | <div class="operation-tags"> | |
| 4221 | <a class="label" href="#tag-VideoAbuse">VideoAbuse</a> | |
| 4222 | <!----> | |
| 4223 | </div> | |
| 4224 | <!-- </div> --> | |
| 4225 | <!-- </section> --> | |
| 4226 | <h2 class="operation-title"> | |
| 4227 | <span class="operation-name"> | |
| 4228 | <span class="operation-name">GET</span> | |
| ab0ee6a1 | 4229 | <span class="operation-path">/videos/abuse</span> |
| 5e1c08eb C |
4230 | </span> |
| 4231 | </h2> | |
| 4232 | <div class="doc-row"> | |
| ab0ee6a1 C |
4233 | <div class="doc-copy"> |
| 4234 | <section class="swagger-request-params"> | |
| 4235 | <div class="prop-row prop-group"> | |
| 4236 | <div class="prop-name"> | |
| 4237 | <div class="prop-title">start</div> | |
| 228e84aa C |
4238 | <div class="prop-subtitle"> in query </div> |
| 4239 | <div class="prop-subtitle"> | |
| 4240 | <span class="json-property-type">number</span> | |
| 4241 | <span class="json-property-range" title="Value limits"></span> | |
| 4242 | </div> | |
| ab0ee6a1 C |
4243 | </div> |
| 4244 | <div class="prop-value"> | |
| 4245 | <p>starting page</p> | |
| 4246 | </div> | |
| 4247 | </div> | |
| ab0ee6a1 C |
4248 | <div class="prop-row prop-group"> |
| 4249 | <div class="prop-name"> | |
| 4250 | <div class="prop-title">stop</div> | |
| 228e84aa C |
4251 | <div class="prop-subtitle"> in query </div> |
| 4252 | <div class="prop-subtitle"> | |
| 4253 | <span class="json-property-type">number</span> | |
| 4254 | <span class="json-property-range" title="Value limits"></span> | |
| 4255 | </div> | |
| ab0ee6a1 C |
4256 | </div> |
| 4257 | <div class="prop-value"> | |
| f209b32a | 4258 | <p>stopping page</p> |
| ab0ee6a1 C |
4259 | </div> |
| 4260 | </div> | |
| ab0ee6a1 C |
4261 | <div class="prop-row prop-group"> |
| 4262 | <div class="prop-name"> | |
| 4263 | <div class="prop-title">sort</div> | |
| 228e84aa C |
4264 | <div class="prop-subtitle"> in query </div> |
| 4265 | <div class="prop-subtitle"> | |
| 4266 | <span class="json-property-type">number</span> | |
| 4267 | <span class="json-property-range" title="Value limits"></span> | |
| 4268 | </div> | |
| ab0ee6a1 C |
4269 | </div> |
| 4270 | <div class="prop-value"> | |
| 4271 | <p>sorting</p> | |
| 4272 | </div> | |
| 4273 | </div> | |
| ab0ee6a1 C |
4274 | </section> |
| 4275 | </div> | |
| 5e1c08eb C |
4276 | <div class="doc-examples"></div> |
| 4277 | </div> | |
| 4278 | <div class="doc-row"> | |
| 4279 | <div class="doc-copy"> | |
| 4280 | <section class="swagger-responses"> | |
| 4281 | <div class="prop-row prop-group"> | |
| 4282 | <div class="prop-name"> | |
| 4283 | <div class="prop-title">200 OK</div> | |
| 4284 | <div class="prop-ref"> | |
| 4285 | <span class="json-schema-ref-array"> | |
| 4286 | <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a> | |
| 4287 | </span> | |
| 4288 | </div> | |
| 4289 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 4290 | </div> | |
| 4291 | <div class="prop-value"> | |
| 4292 | <p>successful operation</p> | |
| 4293 | </div> | |
| 4294 | </div> | |
| 228e84aa C |
4295 | <div class="prop-row prop-inner"> |
| 4296 | <div class="prop-name">type</div> | |
| 4297 | <div class="prop-value"> | |
| 4298 | <span class="json-property-type"> | |
| 4299 | <span class="json-schema-ref-array"> | |
| 4300 | <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a> | |
| 4301 | </span> | |
| 4302 | </span> | |
| 4303 | <span class="json-property-range" title="Value limits"></span> | |
| 4304 | </div> | |
| 4305 | </div> | |
| 5e1c08eb C |
4306 | </section> |
| 4307 | </div> | |
| 4308 | <div class="doc-examples"> | |
| 4309 | <h5>Response Content-Types: | |
| 4310 | <span>application/json</span> | |
| 4311 | </h5> | |
| 4312 | <section> | |
| 4313 | <h5>Response Example | |
| 4314 | <span>(200 OK)</span> | |
| 4315 | </h5> | |
| 4316 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 4317 | { | |
| 4318 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 4319 | <span class="hljs-attr">"reason"</span>: <span class="hljs-string">"string"</span>, | |
| 5d00a3d7 C |
4320 | <span class="hljs-attr">"reporterAccount"</span>: { |
| 4321 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 4322 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 4323 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 4324 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 4325 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 4326 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 4327 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 4328 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 4329 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4330 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4331 | <span class="hljs-attr">"avatar"</span>: { | |
| 4332 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 4333 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4334 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 4335 | } | |
| 4336 | }, | |
| 61b66b36 C |
4337 | <span class="hljs-attr">"video"</span>: { |
| 4338 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 4339 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 4340 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 4341 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span> | |
| 4342 | }, | |
| 5e1c08eb C |
4343 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span> |
| 4344 | } | |
| 4345 | ] | |
| 4346 | </code></pre> | |
| 4347 | <!-- </div> --> | |
| 4348 | </section> | |
| 4349 | </div> | |
| 4350 | </div> | |
| 94ff4c23 C |
4351 | <div class="doc-row"> |
| 4352 | <div class="doc-copy"> | |
| 4353 | <section class="swagger-request-security"> | |
| 4354 | <table class="table"> | |
| 4355 | <thead> | |
| 4356 | <tr> | |
| 4357 | <th class="swagger-request-security-schema"></th> | |
| 4358 | <th class="swagger-request-security-scopes"></th> | |
| 4359 | </tr> | |
| 4360 | </thead> | |
| 4361 | <tbody> | |
| 4362 | <tr> | |
| 4363 | <td> | |
| 4364 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 4365 | </td> | |
| 4366 | <td> </td> | |
| 4367 | </tr> | |
| 4368 | </tbody> | |
| 4369 | </table> | |
| 4370 | </section> | |
| 4371 | </div> | |
| 4372 | </div> | |
| 5e1c08eb | 4373 | </div> |
| ab0ee6a1 | 4374 | <div id="operation--videos--id--abuse-post" class="operation panel" data-traverse-target="operation--videos--id--abuse-post"> |
| 5e1c08eb C |
4375 | <!-- <section class="operation-tags row"> --> |
| 4376 | <!-- <div class="doc-copy"> --> | |
| 4377 | <div class="operation-tags"> | |
| 4378 | <a class="label" href="#tag-VideoAbuse">VideoAbuse</a> | |
| 4379 | <!----> | |
| 4380 | </div> | |
| 4381 | <!-- </div> --> | |
| 4382 | <!-- </section> --> | |
| 4383 | <h2 class="operation-title"> | |
| 4384 | <span class="operation-name"> | |
| 4385 | <span class="operation-name">POST</span> | |
| ab0ee6a1 | 4386 | <span class="operation-path">/videos/{id}/abuse</span> |
| 5e1c08eb C |
4387 | </span> |
| 4388 | </h2> | |
| 4389 | <div class="doc-row"> | |
| 4390 | <div class="doc-copy"> | |
| 4391 | <section class="swagger-request-params"> | |
| 4392 | <div class="prop-row prop-group"> | |
| 4393 | <div class="prop-name"> | |
| 4394 | <div class="prop-title">id</div> | |
| 4395 | <span class="json-property-required"></span> | |
| 228e84aa C |
4396 | <div class="prop-subtitle"> in path </div> |
| 4397 | <div class="prop-subtitle"> | |
| 4398 | <span class="json-property-type">string</span> | |
| 4399 | <span class="json-property-range" title="Value limits"></span> | |
| 4400 | </div> | |
| 5e1c08eb C |
4401 | </div> |
| 4402 | <div class="prop-value"> | |
| 4403 | <p>The video id </p> | |
| 4404 | </div> | |
| 4405 | </div> | |
| 5e1c08eb C |
4406 | </section> |
| 4407 | </div> | |
| 4408 | <div class="doc-examples"></div> | |
| 4409 | </div> | |
| 4410 | <div class="doc-row"> | |
| 4411 | <div class="doc-copy"> | |
| 4412 | <section class="swagger-responses"> | |
| 4413 | <div class="prop-row prop-group"> | |
| 4414 | <div class="prop-name"> | |
| 4415 | <div class="prop-title">204 No Content</div> | |
| 4416 | </div> | |
| 4417 | <div class="prop-value"> | |
| 4418 | <p>successful operation</p> | |
| 4419 | </div> | |
| 4420 | </div> | |
| 4421 | </section> | |
| 4422 | </div> | |
| 4423 | <div class="doc-examples"> | |
| 4424 | <h5>Response Content-Types: | |
| 4425 | <span>application/json</span> | |
| 4426 | </h5> | |
| 4427 | </div> | |
| 4428 | </div> | |
| 94ff4c23 C |
4429 | <div class="doc-row"> |
| 4430 | <div class="doc-copy"> | |
| 4431 | <section class="swagger-request-security"> | |
| 4432 | <table class="table"> | |
| 4433 | <thead> | |
| 4434 | <tr> | |
| 4435 | <th class="swagger-request-security-schema"></th> | |
| 4436 | <th class="swagger-request-security-scopes"></th> | |
| 4437 | </tr> | |
| 4438 | </thead> | |
| 4439 | <tbody> | |
| 4440 | <tr> | |
| 4441 | <td> | |
| 4442 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 4443 | </td> | |
| 4444 | <td> </td> | |
| 4445 | </tr> | |
| 4446 | </tbody> | |
| 4447 | </table> | |
| 4448 | </section> | |
| 4449 | </div> | |
| 4450 | </div> | |
| 5e1c08eb C |
4451 | </div> |
| 4452 | <h1 id="tag-VideoBlacklist" class="swagger-summary-tag" data-traverse-target="tag-VideoBlacklist">VideoBlacklist</h1> | |
| ab0ee6a1 | 4453 | <div id="operation--videos--videoId--blacklist-post" class="operation panel" data-traverse-target="operation--videos--videoId--blacklist-post"> |
| 5e1c08eb C |
4454 | <!-- <section class="operation-tags row"> --> |
| 4455 | <!-- <div class="doc-copy"> --> | |
| 4456 | <div class="operation-tags"> | |
| 4457 | <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> | |
| 4458 | <!----> | |
| 4459 | </div> | |
| 4460 | <!-- </div> --> | |
| 4461 | <!-- </section> --> | |
| 4462 | <h2 class="operation-title"> | |
| 4463 | <span class="operation-name"> | |
| 4464 | <span class="operation-name">POST</span> | |
| ab0ee6a1 | 4465 | <span class="operation-path">/videos/{videoId}/blacklist</span> |
| 5e1c08eb C |
4466 | </span> |
| 4467 | </h2> | |
| 4468 | <div class="doc-row"> | |
| 4469 | <div class="doc-copy"> | |
| 4470 | <section class="swagger-request-params"> | |
| 4471 | <div class="prop-row prop-group"> | |
| 4472 | <div class="prop-name"> | |
| 4473 | <div class="prop-title">videoId</div> | |
| 4474 | <span class="json-property-required"></span> | |
| 228e84aa C |
4475 | <div class="prop-subtitle"> in path </div> |
| 4476 | <div class="prop-subtitle"> | |
| 4477 | <span class="json-property-type">string</span> | |
| 4478 | <span class="json-property-range" title="Value limits"></span> | |
| 4479 | </div> | |
| 5e1c08eb C |
4480 | </div> |
| 4481 | <div class="prop-value"> | |
| 4482 | <p>The video id </p> | |
| 4483 | </div> | |
| 4484 | </div> | |
| 5e1c08eb C |
4485 | </section> |
| 4486 | </div> | |
| 4487 | <div class="doc-examples"></div> | |
| 4488 | </div> | |
| 4489 | <div class="doc-row"> | |
| 4490 | <div class="doc-copy"> | |
| 4491 | <section class="swagger-responses"> | |
| 4492 | <div class="prop-row prop-group"> | |
| 4493 | <div class="prop-name"> | |
| 4494 | <div class="prop-title">204 No Content</div> | |
| 4495 | </div> | |
| 4496 | <div class="prop-value"> | |
| 4497 | <p>successful operation</p> | |
| 4498 | </div> | |
| 4499 | </div> | |
| 4500 | </section> | |
| 4501 | </div> | |
| 4502 | <div class="doc-examples"> | |
| 4503 | <h5>Response Content-Types: | |
| 4504 | <span>application/json</span> | |
| 4505 | </h5> | |
| 4506 | </div> | |
| 4507 | </div> | |
| 94ff4c23 C |
4508 | <div class="doc-row"> |
| 4509 | <div class="doc-copy"> | |
| 4510 | <section class="swagger-request-security"> | |
| 4511 | <table class="table"> | |
| 4512 | <thead> | |
| 4513 | <tr> | |
| 4514 | <th class="swagger-request-security-schema"></th> | |
| 4515 | <th class="swagger-request-security-scopes"></th> | |
| 4516 | </tr> | |
| 4517 | </thead> | |
| 4518 | <tbody> | |
| 4519 | <tr> | |
| 4520 | <td> | |
| 4521 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 4522 | </td> | |
| 4523 | <td> </td> | |
| 4524 | </tr> | |
| 4525 | </tbody> | |
| 4526 | </table> | |
| 4527 | </section> | |
| 4528 | </div> | |
| 4529 | </div> | |
| 5e1c08eb | 4530 | </div> |
| ab0ee6a1 | 4531 | <div id="operation--videos--videoId--blacklist-delete" class="operation panel" data-traverse-target="operation--videos--videoId--blacklist-delete"> |
| 5e1c08eb C |
4532 | <!-- <section class="operation-tags row"> --> |
| 4533 | <!-- <div class="doc-copy"> --> | |
| 4534 | <div class="operation-tags"> | |
| 4535 | <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> | |
| 4536 | <!----> | |
| 4537 | </div> | |
| 4538 | <!-- </div> --> | |
| 4539 | <!-- </section> --> | |
| 4540 | <h2 class="operation-title"> | |
| 4541 | <span class="operation-name"> | |
| 4542 | <span class="operation-name">DELETE</span> | |
| ab0ee6a1 | 4543 | <span class="operation-path">/videos/{videoId}/blacklist</span> |
| 5e1c08eb C |
4544 | </span> |
| 4545 | </h2> | |
| 4546 | <div class="doc-row"> | |
| 4547 | <div class="doc-copy"> | |
| 4548 | <section class="swagger-request-params"> | |
| 4549 | <div class="prop-row prop-group"> | |
| 4550 | <div class="prop-name"> | |
| 4551 | <div class="prop-title">videoId</div> | |
| 4552 | <span class="json-property-required"></span> | |
| 228e84aa C |
4553 | <div class="prop-subtitle"> in path </div> |
| 4554 | <div class="prop-subtitle"> | |
| 4555 | <span class="json-property-type">string</span> | |
| 4556 | <span class="json-property-range" title="Value limits"></span> | |
| 4557 | </div> | |
| 5e1c08eb C |
4558 | </div> |
| 4559 | <div class="prop-value"> | |
| 4560 | <p>The video id </p> | |
| 4561 | </div> | |
| 4562 | </div> | |
| 5e1c08eb C |
4563 | </section> |
| 4564 | </div> | |
| 4565 | <div class="doc-examples"></div> | |
| 4566 | </div> | |
| 4567 | <div class="doc-row"> | |
| 4568 | <div class="doc-copy"> | |
| 4569 | <section class="swagger-responses"> | |
| 4570 | <div class="prop-row prop-group"> | |
| 4571 | <div class="prop-name"> | |
| 4572 | <div class="prop-title">204 No Content</div> | |
| 4573 | </div> | |
| 4574 | <div class="prop-value"> | |
| 4575 | <p>successful operation</p> | |
| 4576 | </div> | |
| 4577 | </div> | |
| 4578 | </section> | |
| 4579 | </div> | |
| 4580 | <div class="doc-examples"> | |
| 4581 | <h5>Response Content-Types: | |
| 4582 | <span>application/json</span> | |
| 4583 | </h5> | |
| 4584 | </div> | |
| 4585 | </div> | |
| 94ff4c23 C |
4586 | <div class="doc-row"> |
| 4587 | <div class="doc-copy"> | |
| 4588 | <section class="swagger-request-security"> | |
| 4589 | <table class="table"> | |
| 4590 | <thead> | |
| 4591 | <tr> | |
| 4592 | <th class="swagger-request-security-schema"></th> | |
| 4593 | <th class="swagger-request-security-scopes"></th> | |
| 4594 | </tr> | |
| 4595 | </thead> | |
| 4596 | <tbody> | |
| 4597 | <tr> | |
| 4598 | <td> | |
| 4599 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 4600 | </td> | |
| 4601 | <td> </td> | |
| 4602 | </tr> | |
| 4603 | </tbody> | |
| 4604 | </table> | |
| 4605 | </section> | |
| 4606 | </div> | |
| 4607 | </div> | |
| 5e1c08eb | 4608 | </div> |
| ab0ee6a1 | 4609 | <div id="operation--videos-blacklist-get" class="operation panel" data-traverse-target="operation--videos-blacklist-get"> |
| 5e1c08eb C |
4610 | <!-- <section class="operation-tags row"> --> |
| 4611 | <!-- <div class="doc-copy"> --> | |
| 4612 | <div class="operation-tags"> | |
| 4613 | <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> | |
| 4614 | <!----> | |
| 4615 | </div> | |
| 4616 | <!-- </div> --> | |
| 4617 | <!-- </section> --> | |
| 4618 | <h2 class="operation-title"> | |
| 4619 | <span class="operation-name"> | |
| 4620 | <span class="operation-name">GET</span> | |
| ab0ee6a1 | 4621 | <span class="operation-path">/videos/blacklist</span> |
| 5e1c08eb C |
4622 | </span> |
| 4623 | </h2> | |
| 4624 | <div class="doc-row"> | |
| ab0ee6a1 C |
4625 | <div class="doc-copy"> |
| 4626 | <section class="swagger-request-params"> | |
| 4627 | <div class="prop-row prop-group"> | |
| 4628 | <div class="prop-name"> | |
| 4629 | <div class="prop-title">start</div> | |
| 228e84aa C |
4630 | <div class="prop-subtitle"> in query </div> |
| 4631 | <div class="prop-subtitle"> | |
| 4632 | <span class="json-property-type">number</span> | |
| 4633 | <span class="json-property-range" title="Value limits"></span> | |
| 4634 | </div> | |
| ab0ee6a1 C |
4635 | </div> |
| 4636 | <div class="prop-value"> | |
| 4637 | <p>starting page</p> | |
| 4638 | </div> | |
| 4639 | </div> | |
| ab0ee6a1 C |
4640 | <div class="prop-row prop-group"> |
| 4641 | <div class="prop-name"> | |
| 4642 | <div class="prop-title">stop</div> | |
| 228e84aa C |
4643 | <div class="prop-subtitle"> in query </div> |
| 4644 | <div class="prop-subtitle"> | |
| 4645 | <span class="json-property-type">number</span> | |
| 4646 | <span class="json-property-range" title="Value limits"></span> | |
| 4647 | </div> | |
| ab0ee6a1 C |
4648 | </div> |
| 4649 | <div class="prop-value"> | |
| f209b32a | 4650 | <p>stopping page</p> |
| ab0ee6a1 C |
4651 | </div> |
| 4652 | </div> | |
| ab0ee6a1 C |
4653 | <div class="prop-row prop-group"> |
| 4654 | <div class="prop-name"> | |
| 4655 | <div class="prop-title">sort</div> | |
| 228e84aa C |
4656 | <div class="prop-subtitle"> in query </div> |
| 4657 | <div class="prop-subtitle"> | |
| 4658 | <span class="json-property-type">number</span> | |
| 4659 | <span class="json-property-range" title="Value limits"></span> | |
| 4660 | </div> | |
| ab0ee6a1 C |
4661 | </div> |
| 4662 | <div class="prop-value"> | |
| 4663 | <p>sorting</p> | |
| 4664 | </div> | |
| 4665 | </div> | |
| ab0ee6a1 C |
4666 | </section> |
| 4667 | </div> | |
| 5e1c08eb C |
4668 | <div class="doc-examples"></div> |
| 4669 | </div> | |
| 4670 | <div class="doc-row"> | |
| 4671 | <div class="doc-copy"> | |
| 4672 | <section class="swagger-responses"> | |
| 4673 | <div class="prop-row prop-group"> | |
| 4674 | <div class="prop-name"> | |
| 4675 | <div class="prop-title">200 OK</div> | |
| 4676 | <div class="prop-ref"> | |
| 4677 | <span class="json-schema-ref-array"> | |
| 4678 | <a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a> | |
| 4679 | </span> | |
| 4680 | </div> | |
| 4681 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 4682 | </div> | |
| 4683 | <div class="prop-value"> | |
| 4684 | <p>successful operation</p> | |
| 4685 | </div> | |
| 4686 | </div> | |
| 228e84aa C |
4687 | <div class="prop-row prop-inner"> |
| 4688 | <div class="prop-name">type</div> | |
| 4689 | <div class="prop-value"> | |
| 4690 | <span class="json-property-type"> | |
| 4691 | <span class="json-schema-ref-array"> | |
| 4692 | <a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a> | |
| 4693 | </span> | |
| 4694 | </span> | |
| 4695 | <span class="json-property-range" title="Value limits"></span> | |
| 4696 | </div> | |
| 4697 | </div> | |
| 5e1c08eb C |
4698 | </section> |
| 4699 | </div> | |
| 4700 | <div class="doc-examples"> | |
| 4701 | <h5>Response Content-Types: | |
| 4702 | <span>application/json</span> | |
| 4703 | </h5> | |
| 4704 | <section> | |
| 4705 | <h5>Response Example | |
| 4706 | <span>(200 OK)</span> | |
| 4707 | </h5> | |
| 4708 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 4709 | { | |
| 4710 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 4711 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 4712 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4713 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4714 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 4715 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 4716 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 4717 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 4718 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 4719 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 4720 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 4721 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
| 4722 | } | |
| 4723 | ] | |
| 4724 | </code></pre> | |
| 4725 | <!-- </div> --> | |
| 4726 | </section> | |
| 4727 | </div> | |
| 4728 | </div> | |
| 94ff4c23 C |
4729 | <div class="doc-row"> |
| 4730 | <div class="doc-copy"> | |
| 4731 | <section class="swagger-request-security"> | |
| 4732 | <table class="table"> | |
| 4733 | <thead> | |
| 4734 | <tr> | |
| 4735 | <th class="swagger-request-security-schema"></th> | |
| 4736 | <th class="swagger-request-security-scopes"></th> | |
| 4737 | </tr> | |
| 4738 | </thead> | |
| 4739 | <tbody> | |
| 4740 | <tr> | |
| 4741 | <td> | |
| 4742 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 4743 | </td> | |
| 4744 | <td> </td> | |
| 4745 | </tr> | |
| 4746 | </tbody> | |
| 4747 | </table> | |
| 4748 | </section> | |
| 4749 | </div> | |
| 4750 | </div> | |
| 5e1c08eb C |
4751 | </div> |
| 4752 | <h1 id="tag-VideoChannel" class="swagger-summary-tag" data-traverse-target="tag-VideoChannel">VideoChannel</h1> | |
| 48dce1c9 | 4753 | <div id="operation--video-channels-get" class="operation panel" data-traverse-target="operation--video-channels-get"> |
| 5e1c08eb C |
4754 | <!-- <section class="operation-tags row"> --> |
| 4755 | <!-- <div class="doc-copy"> --> | |
| 4756 | <div class="operation-tags"> | |
| 4757 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
| 4758 | <!----> | |
| 4759 | </div> | |
| 4760 | <!-- </div> --> | |
| 4761 | <!-- </section> --> | |
| 4762 | <h2 class="operation-title"> | |
| 4763 | <span class="operation-name"> | |
| 4764 | <span class="operation-name">GET</span> | |
| 48dce1c9 | 4765 | <span class="operation-path">/video-channels</span> |
| 5e1c08eb C |
4766 | </span> |
| 4767 | </h2> | |
| 4768 | <div class="doc-row"> | |
| ab0ee6a1 C |
4769 | <div class="doc-copy"> |
| 4770 | <section class="swagger-request-params"> | |
| 4771 | <div class="prop-row prop-group"> | |
| 4772 | <div class="prop-name"> | |
| 4773 | <div class="prop-title">start</div> | |
| 228e84aa C |
4774 | <div class="prop-subtitle"> in query </div> |
| 4775 | <div class="prop-subtitle"> | |
| 4776 | <span class="json-property-type">number</span> | |
| 4777 | <span class="json-property-range" title="Value limits"></span> | |
| 4778 | </div> | |
| ab0ee6a1 C |
4779 | </div> |
| 4780 | <div class="prop-value"> | |
| 4781 | <p>starting page</p> | |
| 4782 | </div> | |
| 4783 | </div> | |
| ab0ee6a1 C |
4784 | <div class="prop-row prop-group"> |
| 4785 | <div class="prop-name"> | |
| 4786 | <div class="prop-title">stop</div> | |
| 228e84aa C |
4787 | <div class="prop-subtitle"> in query </div> |
| 4788 | <div class="prop-subtitle"> | |
| 4789 | <span class="json-property-type">number</span> | |
| 4790 | <span class="json-property-range" title="Value limits"></span> | |
| 4791 | </div> | |
| ab0ee6a1 C |
4792 | </div> |
| 4793 | <div class="prop-value"> | |
| f209b32a | 4794 | <p>stopping page</p> |
| ab0ee6a1 C |
4795 | </div> |
| 4796 | </div> | |
| ab0ee6a1 C |
4797 | <div class="prop-row prop-group"> |
| 4798 | <div class="prop-name"> | |
| 4799 | <div class="prop-title">sort</div> | |
| 228e84aa C |
4800 | <div class="prop-subtitle"> in query </div> |
| 4801 | <div class="prop-subtitle"> | |
| 4802 | <span class="json-property-type">number</span> | |
| 4803 | <span class="json-property-range" title="Value limits"></span> | |
| 4804 | </div> | |
| ab0ee6a1 C |
4805 | </div> |
| 4806 | <div class="prop-value"> | |
| 4807 | <p>sorting</p> | |
| 4808 | </div> | |
| 4809 | </div> | |
| ab0ee6a1 C |
4810 | </section> |
| 4811 | </div> | |
| 5e1c08eb C |
4812 | <div class="doc-examples"></div> |
| 4813 | </div> | |
| 4814 | <div class="doc-row"> | |
| 4815 | <div class="doc-copy"> | |
| 4816 | <section class="swagger-responses"> | |
| 4817 | <div class="prop-row prop-group"> | |
| 4818 | <div class="prop-name"> | |
| 4819 | <div class="prop-title">200 OK</div> | |
| 4820 | <div class="prop-ref"> | |
| 4821 | <span class="json-schema-ref-array"> | |
| 4822 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
| 4823 | </span> | |
| 4824 | </div> | |
| 4825 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 4826 | </div> | |
| 4827 | <div class="prop-value"> | |
| 4828 | <p>successful operation</p> | |
| 4829 | </div> | |
| 4830 | </div> | |
| 228e84aa C |
4831 | <div class="prop-row prop-inner"> |
| 4832 | <div class="prop-name">type</div> | |
| 4833 | <div class="prop-value"> | |
| 4834 | <span class="json-property-type"> | |
| 4835 | <span class="json-schema-ref-array"> | |
| 4836 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
| 4837 | </span> | |
| 4838 | </span> | |
| 4839 | <span class="json-property-range" title="Value limits"></span> | |
| 4840 | </div> | |
| 4841 | </div> | |
| 5e1c08eb C |
4842 | </section> |
| 4843 | </div> | |
| 4844 | <div class="doc-examples"> | |
| 4845 | <h5>Response Content-Types: | |
| 4846 | <span>application/json</span> | |
| 4847 | </h5> | |
| 4848 | <section> | |
| 4849 | <h5>Response Example | |
| 4850 | <span>(200 OK)</span> | |
| 4851 | </h5> | |
| 4852 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 4853 | { | |
| 4854 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 4855 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 4856 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| cc918ac3 C |
4857 | <span class="hljs-attr">"ownerAccount"</span>: { |
| 4858 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5e1c08eb | 4859 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> |
| cc918ac3 | 4860 | } |
| 48dce1c9 C |
4861 | } |
| 4862 | ] | |
| 4863 | </code></pre> | |
| 4864 | <!-- </div> --> | |
| 4865 | </section> | |
| 4866 | </div> | |
| 4867 | </div> | |
| 4868 | </div> | |
| cc918ac3 | 4869 | <div id="operation--video-channels-post" class="operation panel" data-traverse-target="operation--video-channels-post"> |
| 48dce1c9 C |
4870 | <!-- <section class="operation-tags row"> --> |
| 4871 | <!-- <div class="doc-copy"> --> | |
| 4872 | <div class="operation-tags"> | |
| 4873 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
| 4874 | <!----> | |
| 4875 | </div> | |
| 4876 | <!-- </div> --> | |
| 4877 | <!-- </section> --> | |
| 4878 | <h2 class="operation-title"> | |
| 4879 | <span class="operation-name"> | |
| cc918ac3 C |
4880 | <span class="operation-name">POST</span> |
| 4881 | <span class="operation-path">/video-channels</span> | |
| 48dce1c9 C |
4882 | </span> |
| 4883 | </h2> | |
| 4884 | <div class="doc-row"> | |
| 4885 | <div class="doc-copy"> | |
| cc918ac3 C |
4886 | <section class="swagger-request-body"> |
| 4887 | <div class="prop-row"> | |
| 48dce1c9 | 4888 | <div class="prop-name"> |
| cc918ac3 C |
4889 | <div class="swagger-request-model"> |
| 4890 | <span class=""> | |
| 4891 | <a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a> | |
| 4892 | </span> | |
| 48dce1c9 C |
4893 | </div> |
| 4894 | </div> | |
| cc918ac3 C |
4895 | <div class="prop-value columns small-6"> |
| 4896 | <!-- <div class="swagger-request-description"> --> | |
| 4897 | <p>undefined</p> | |
| 4898 | <!-- </div> --> | |
| 48dce1c9 C |
4899 | </div> |
| 4900 | </div> | |
| 4901 | </section> | |
| 4902 | </div> | |
| cc918ac3 C |
4903 | <div class="doc-examples"> |
| 4904 | <section> | |
| 4905 | <h5>Request Content-Types: | |
| 4906 | <span>application/json</span> | |
| 4907 | </h5> | |
| 4908 | <h5>Request Example</h5> | |
| 4909 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 4910 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 4911 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span> | |
| 4912 | } | |
| 4913 | </code></pre> | |
| 4914 | <!-- </div> --> | |
| 4915 | </section> | |
| 4916 | </div> | |
| 48dce1c9 C |
4917 | </div> |
| 4918 | <div class="doc-row"> | |
| 4919 | <div class="doc-copy"> | |
| 4920 | <section class="swagger-responses"> | |
| 4921 | <div class="prop-row prop-group"> | |
| 4922 | <div class="prop-name"> | |
| cc918ac3 | 4923 | <div class="prop-title">204 No Content</div> |
| 5e1c08eb C |
4924 | </div> |
| 4925 | <div class="prop-value"> | |
| 4926 | <p>successful operation</p> | |
| 4927 | </div> | |
| 4928 | </div> | |
| 4929 | </section> | |
| 4930 | </div> | |
| 4931 | <div class="doc-examples"> | |
| 4932 | <h5>Response Content-Types: | |
| 4933 | <span>application/json</span> | |
| 4934 | </h5> | |
| 4935 | </div> | |
| 4936 | </div> | |
| 94ff4c23 C |
4937 | <div class="doc-row"> |
| 4938 | <div class="doc-copy"> | |
| 4939 | <section class="swagger-request-security"> | |
| 4940 | <table class="table"> | |
| 4941 | <thead> | |
| 4942 | <tr> | |
| 4943 | <th class="swagger-request-security-schema"></th> | |
| 4944 | <th class="swagger-request-security-scopes"></th> | |
| 4945 | </tr> | |
| 4946 | </thead> | |
| 4947 | <tbody> | |
| 4948 | <tr> | |
| 4949 | <td> | |
| 4950 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 4951 | </td> | |
| 4952 | <td> </td> | |
| 4953 | </tr> | |
| 4954 | </tbody> | |
| 4955 | </table> | |
| 4956 | </section> | |
| 4957 | </div> | |
| 4958 | </div> | |
| 5e1c08eb | 4959 | </div> |
| cc918ac3 | 4960 | <div id="operation--video-channels--id--get" class="operation panel" data-traverse-target="operation--video-channels--id--get"> |
| 5e1c08eb C |
4961 | <!-- <section class="operation-tags row"> --> |
| 4962 | <!-- <div class="doc-copy"> --> | |
| 4963 | <div class="operation-tags"> | |
| 4964 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
| 4965 | <!----> | |
| 4966 | </div> | |
| 4967 | <!-- </div> --> | |
| 4968 | <!-- </section> --> | |
| 4969 | <h2 class="operation-title"> | |
| 4970 | <span class="operation-name"> | |
| 4971 | <span class="operation-name">GET</span> | |
| cc918ac3 | 4972 | <span class="operation-path">/video-channels/{id}</span> |
| 5e1c08eb C |
4973 | </span> |
| 4974 | </h2> | |
| 4975 | <div class="doc-row"> | |
| 4976 | <div class="doc-copy"> | |
| 4977 | <section class="swagger-request-params"> | |
| 4978 | <div class="prop-row prop-group"> | |
| 4979 | <div class="prop-name"> | |
| 4980 | <div class="prop-title">id</div> | |
| 4981 | <span class="json-property-required"></span> | |
| 228e84aa C |
4982 | <div class="prop-subtitle"> in path </div> |
| 4983 | <div class="prop-subtitle"> | |
| 4984 | <span class="json-property-type">string</span> | |
| 4985 | <span class="json-property-range" title="Value limits"></span> | |
| 4986 | </div> | |
| 5e1c08eb C |
4987 | </div> |
| 4988 | <div class="prop-value"> | |
| 48dce1c9 | 4989 | <p>The video channel id </p> |
| 5e1c08eb C |
4990 | </div> |
| 4991 | </div> | |
| 5e1c08eb C |
4992 | </section> |
| 4993 | </div> | |
| 4994 | <div class="doc-examples"></div> | |
| 4995 | </div> | |
| 4996 | <div class="doc-row"> | |
| 4997 | <div class="doc-copy"> | |
| 4998 | <section class="swagger-responses"> | |
| 4999 | <div class="prop-row prop-group"> | |
| 5000 | <div class="prop-name"> | |
| 5001 | <div class="prop-title">200 OK</div> | |
| 5002 | <div class="prop-ref"> | |
| 5003 | <span class=""> | |
| 5004 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
| 5005 | </span> | |
| 5006 | </div> | |
| 5007 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 5008 | </div> | |
| 5009 | <div class="prop-value"> | |
| 5010 | <p>successful operation</p> | |
| 5011 | </div> | |
| 5012 | </div> | |
| 5013 | </section> | |
| 5014 | </div> | |
| 5015 | <div class="doc-examples"> | |
| 5016 | <h5>Response Content-Types: | |
| 5017 | <span>application/json</span> | |
| 5018 | </h5> | |
| 5019 | <section> | |
| 5020 | <h5>Response Example | |
| 5021 | <span>(200 OK)</span> | |
| 5022 | </h5> | |
| 5023 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 5024 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 5025 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 5026 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| cc918ac3 C |
5027 | <span class="hljs-attr">"ownerAccount"</span>: { |
| 5028 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5e1c08eb | 5029 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> |
| cc918ac3 | 5030 | } |
| 5e1c08eb C |
5031 | } |
| 5032 | </code></pre> | |
| 5033 | <!-- </div> --> | |
| 5034 | </section> | |
| 5035 | </div> | |
| 5036 | </div> | |
| 5037 | </div> | |
| cc918ac3 | 5038 | <div id="operation--video-channels--id--put" class="operation panel" data-traverse-target="operation--video-channels--id--put"> |
| 5e1c08eb C |
5039 | <!-- <section class="operation-tags row"> --> |
| 5040 | <!-- <div class="doc-copy"> --> | |
| 5041 | <div class="operation-tags"> | |
| 5042 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
| 5043 | <!----> | |
| 5044 | </div> | |
| 5045 | <!-- </div> --> | |
| 5046 | <!-- </section> --> | |
| 5047 | <h2 class="operation-title"> | |
| 5048 | <span class="operation-name"> | |
| 5049 | <span class="operation-name">PUT</span> | |
| cc918ac3 | 5050 | <span class="operation-path">/video-channels/{id}</span> |
| 5e1c08eb C |
5051 | </span> |
| 5052 | </h2> | |
| 5053 | <div class="doc-row"> | |
| 5054 | <div class="doc-copy"> | |
| 5055 | <section class="swagger-request-body"> | |
| 5056 | <div class="prop-row"> | |
| 5057 | <div class="prop-name"> | |
| 5058 | <div class="swagger-request-model"> | |
| 5059 | <span class=""> | |
| 5060 | <a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a> | |
| 5061 | </span> | |
| 5062 | </div> | |
| 5063 | </div> | |
| 5064 | <div class="prop-value columns small-6"> | |
| 228e84aa C |
5065 | <!-- <div class="swagger-request-description"> --> |
| 5066 | <p>undefined</p> | |
| 5e1c08eb C |
5067 | <!-- </div> --> |
| 5068 | </div> | |
| 5069 | </div> | |
| 5070 | </section> | |
| 5071 | <section class="swagger-request-params"> | |
| 5072 | <div class="prop-row prop-group"> | |
| 5073 | <div class="prop-name"> | |
| 5074 | <div class="prop-title">id</div> | |
| 5075 | <span class="json-property-required"></span> | |
| 228e84aa C |
5076 | <div class="prop-subtitle"> in path </div> |
| 5077 | <div class="prop-subtitle"> | |
| 5078 | <span class="json-property-type">string</span> | |
| 5079 | <span class="json-property-range" title="Value limits"></span> | |
| 5080 | </div> | |
| 5e1c08eb C |
5081 | </div> |
| 5082 | <div class="prop-value"> | |
| 48dce1c9 | 5083 | <p>The video channel id </p> |
| 5e1c08eb C |
5084 | </div> |
| 5085 | </div> | |
| 5e1c08eb C |
5086 | </section> |
| 5087 | </div> | |
| 5088 | <div class="doc-examples"> | |
| 5089 | <section> | |
| 5090 | <h5>Request Content-Types: | |
| 5091 | <span>application/json</span> | |
| 5092 | </h5> | |
| 5093 | <h5>Request Example</h5> | |
| 5094 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 5095 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 5096 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span> | |
| 5097 | } | |
| 5098 | </code></pre> | |
| 5099 | <!-- </div> --> | |
| 5100 | </section> | |
| 5101 | </div> | |
| 5102 | </div> | |
| 5103 | <div class="doc-row"> | |
| 5104 | <div class="doc-copy"> | |
| 5105 | <section class="swagger-responses"> | |
| 5106 | <div class="prop-row prop-group"> | |
| 5107 | <div class="prop-name"> | |
| 5108 | <div class="prop-title">204 No Content</div> | |
| 5109 | </div> | |
| 5110 | <div class="prop-value"> | |
| 5111 | <p>successful operation</p> | |
| 5112 | </div> | |
| 5113 | </div> | |
| 5114 | </section> | |
| 5115 | </div> | |
| 5116 | <div class="doc-examples"> | |
| 5117 | <h5>Response Content-Types: | |
| 5118 | <span>application/json</span> | |
| 5119 | </h5> | |
| 5120 | </div> | |
| 5121 | </div> | |
| 94ff4c23 C |
5122 | <div class="doc-row"> |
| 5123 | <div class="doc-copy"> | |
| 5124 | <section class="swagger-request-security"> | |
| 5125 | <table class="table"> | |
| 5126 | <thead> | |
| 5127 | <tr> | |
| 5128 | <th class="swagger-request-security-schema"></th> | |
| 5129 | <th class="swagger-request-security-scopes"></th> | |
| 5130 | </tr> | |
| 5131 | </thead> | |
| 5132 | <tbody> | |
| 5133 | <tr> | |
| 5134 | <td> | |
| 5135 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 5136 | </td> | |
| 5137 | <td> </td> | |
| 5138 | </tr> | |
| 5139 | </tbody> | |
| 5140 | </table> | |
| 5141 | </section> | |
| 5142 | </div> | |
| 5143 | </div> | |
| 5e1c08eb | 5144 | </div> |
| cc918ac3 | 5145 | <div id="operation--video-channels--id--delete" class="operation panel" data-traverse-target="operation--video-channels--id--delete"> |
| 5e1c08eb C |
5146 | <!-- <section class="operation-tags row"> --> |
| 5147 | <!-- <div class="doc-copy"> --> | |
| 5148 | <div class="operation-tags"> | |
| 5149 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
| 5150 | <!----> | |
| 5151 | </div> | |
| 5152 | <!-- </div> --> | |
| 5153 | <!-- </section> --> | |
| 5154 | <h2 class="operation-title"> | |
| 5155 | <span class="operation-name"> | |
| 5156 | <span class="operation-name">DELETE</span> | |
| cc918ac3 | 5157 | <span class="operation-path">/video-channels/{id}</span> |
| 5e1c08eb C |
5158 | </span> |
| 5159 | </h2> | |
| 5160 | <div class="doc-row"> | |
| 5161 | <div class="doc-copy"> | |
| 5162 | <section class="swagger-request-params"> | |
| 5163 | <div class="prop-row prop-group"> | |
| 5164 | <div class="prop-name"> | |
| 5165 | <div class="prop-title">id</div> | |
| 5166 | <span class="json-property-required"></span> | |
| 228e84aa C |
5167 | <div class="prop-subtitle"> in path </div> |
| 5168 | <div class="prop-subtitle"> | |
| 5169 | <span class="json-property-type">string</span> | |
| 5170 | <span class="json-property-range" title="Value limits"></span> | |
| 5171 | </div> | |
| 5e1c08eb C |
5172 | </div> |
| 5173 | <div class="prop-value"> | |
| 48dce1c9 | 5174 | <p>The video channel id </p> |
| 5e1c08eb C |
5175 | </div> |
| 5176 | </div> | |
| 5e1c08eb C |
5177 | </section> |
| 5178 | </div> | |
| 5179 | <div class="doc-examples"></div> | |
| 5180 | </div> | |
| 5181 | <div class="doc-row"> | |
| 5182 | <div class="doc-copy"> | |
| 5183 | <section class="swagger-responses"> | |
| 5184 | <div class="prop-row prop-group"> | |
| 5185 | <div class="prop-name"> | |
| 5186 | <div class="prop-title">204 No Content</div> | |
| 5187 | </div> | |
| 5188 | <div class="prop-value"> | |
| 5189 | <p>successful operation</p> | |
| 5190 | </div> | |
| 5191 | </div> | |
| 5192 | </section> | |
| 5193 | </div> | |
| 5194 | <div class="doc-examples"> | |
| 5195 | <h5>Response Content-Types: | |
| 5196 | <span>application/json</span> | |
| 5197 | </h5> | |
| 5198 | </div> | |
| 5199 | </div> | |
| 94ff4c23 C |
5200 | <div class="doc-row"> |
| 5201 | <div class="doc-copy"> | |
| 5202 | <section class="swagger-request-security"> | |
| 5203 | <table class="table"> | |
| 5204 | <thead> | |
| 5205 | <tr> | |
| 5206 | <th class="swagger-request-security-schema"></th> | |
| 5207 | <th class="swagger-request-security-scopes"></th> | |
| 5208 | </tr> | |
| 5209 | </thead> | |
| 5210 | <tbody> | |
| 5211 | <tr> | |
| 5212 | <td> | |
| 5213 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 5214 | </td> | |
| 5215 | <td> </td> | |
| 5216 | </tr> | |
| 5217 | </tbody> | |
| 5218 | </table> | |
| 5219 | </section> | |
| 5220 | </div> | |
| 5221 | </div> | |
| 5e1c08eb | 5222 | </div> |
| cc918ac3 C |
5223 | <div id="operation--video-channels--id--videos-get" class="operation panel" data-traverse-target="operation--video-channels--id--videos-get"> |
| 5224 | <!-- <section class="operation-tags row"> --> | |
| 5225 | <!-- <div class="doc-copy"> --> | |
| 5226 | <div class="operation-tags"> | |
| 5227 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
| 5228 | <!----> | |
| 5229 | </div> | |
| 5230 | <!-- </div> --> | |
| 5231 | <!-- </section> --> | |
| 5232 | <h2 class="operation-title"> | |
| 5233 | <span class="operation-name"> | |
| 5234 | <span class="operation-name">GET</span> | |
| 5235 | <span class="operation-path">/video-channels/{id}/videos</span> | |
| 5236 | </span> | |
| 5237 | </h2> | |
| 5238 | <div class="doc-row"> | |
| 5239 | <div class="doc-copy"> | |
| 5240 | <section class="swagger-request-params"> | |
| 5241 | <div class="prop-row prop-group"> | |
| 5242 | <div class="prop-name"> | |
| 5243 | <div class="prop-title">id</div> | |
| 5244 | <span class="json-property-required"></span> | |
| 5245 | <div class="prop-subtitle"> in path </div> | |
| 5246 | <div class="prop-subtitle"> | |
| 5247 | <span class="json-property-type">string</span> | |
| 5248 | <span class="json-property-range" title="Value limits"></span> | |
| 5249 | </div> | |
| 5250 | </div> | |
| 5251 | <div class="prop-value"> | |
| 5252 | <p>The video channel id </p> | |
| 5253 | </div> | |
| 5254 | </div> | |
| 5255 | </section> | |
| 5256 | </div> | |
| 5257 | <div class="doc-examples"></div> | |
| 5258 | </div> | |
| 5259 | <div class="doc-row"> | |
| 5260 | <div class="doc-copy"> | |
| 5261 | <section class="swagger-responses"> | |
| 5262 | <div class="prop-row prop-group"> | |
| 5263 | <div class="prop-name"> | |
| 5264 | <div class="prop-title">200 OK</div> | |
| 5265 | <div class="prop-ref"> | |
| 5266 | <span class=""> | |
| 5267 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
| 5268 | </span> | |
| 5269 | </div> | |
| 5270 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 5271 | </div> | |
| 5272 | <div class="prop-value"> | |
| 5273 | <p>successful operation</p> | |
| 5274 | </div> | |
| 5275 | </div> | |
| 5276 | </section> | |
| 5277 | </div> | |
| 5278 | <div class="doc-examples"> | |
| 5279 | <h5>Response Content-Types: | |
| 5280 | <span>application/json</span> | |
| 5281 | </h5> | |
| 5282 | <section> | |
| 5283 | <h5>Response Example | |
| 5284 | <span>(200 OK)</span> | |
| 5285 | </h5> | |
| 5286 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 5287 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5288 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 5289 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5290 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5291 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5292 | <span class="hljs-attr">"category"</span>: { | |
| 5293 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5294 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 5295 | }, | |
| 5296 | <span class="hljs-attr">"licence"</span>: { | |
| 5297 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5298 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 5299 | }, | |
| 5300 | <span class="hljs-attr">"language"</span>: { | |
| 5301 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
| 5302 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 5303 | }, | |
| 5304 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | |
| 5305 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 5306 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 5307 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 5308 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 5309 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
| 5310 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
| 5311 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
| 5312 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 5313 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 5314 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 5315 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | |
| 5316 | <span class="hljs-attr">"account"</span>: { | |
| 5317 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 5318 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 5319 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 5320 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 5321 | <span class="hljs-attr">"avatar"</span>: { | |
| 5322 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 5323 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5324 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 5325 | } | |
| 5326 | } | |
| 5327 | } | |
| 5328 | </code></pre> | |
| 5329 | <!-- </div> --> | |
| 5330 | </section> | |
| 5331 | </div> | |
| 5332 | </div> | |
| 5333 | </div> | |
| ad9e39fb | 5334 | <div id="operation--accounts--name--video-channels-get" class="operation panel" data-traverse-target="operation--accounts--name--video-channels-get"> |
| cc918ac3 C |
5335 | <!-- <section class="operation-tags row"> --> |
| 5336 | <!-- <div class="doc-copy"> --> | |
| 5337 | <div class="operation-tags"> | |
| 5338 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
| 5339 | <!----> | |
| 5340 | </div> | |
| 5341 | <!-- </div> --> | |
| 5342 | <!-- </section> --> | |
| 5343 | <h2 class="operation-title"> | |
| 5344 | <span class="operation-name"> | |
| 5345 | <span class="operation-name">GET</span> | |
| ad9e39fb | 5346 | <span class="operation-path">/accounts/{name}/video-channels</span> |
| cc918ac3 C |
5347 | </span> |
| 5348 | </h2> | |
| 5349 | <div class="doc-row"> | |
| 5350 | <div class="doc-copy"> | |
| 5351 | <section class="swagger-request-params"> | |
| 5352 | <div class="prop-row prop-group"> | |
| 5353 | <div class="prop-name"> | |
| ad9e39fb | 5354 | <div class="prop-title">name</div> |
| cc918ac3 C |
5355 | <span class="json-property-required"></span> |
| 5356 | <div class="prop-subtitle"> in path </div> | |
| 5357 | <div class="prop-subtitle"> | |
| 5358 | <span class="json-property-type">string</span> | |
| 5359 | <span class="json-property-range" title="Value limits"></span> | |
| 5360 | </div> | |
| 5361 | </div> | |
| 5362 | <div class="prop-value"> | |
| ad9e39fb C |
5363 | <p>The name of the account (chocobozzz or |
| 5364 | <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p> | |
| cc918ac3 C |
5365 | </div> |
| 5366 | </div> | |
| 5367 | </section> | |
| 5368 | </div> | |
| 5369 | <div class="doc-examples"></div> | |
| 5370 | </div> | |
| 5371 | <div class="doc-row"> | |
| 5372 | <div class="doc-copy"> | |
| 5373 | <section class="swagger-responses"> | |
| 5374 | <div class="prop-row prop-group"> | |
| 5375 | <div class="prop-name"> | |
| 5376 | <div class="prop-title">200 OK</div> | |
| 5377 | <div class="prop-ref"> | |
| 5378 | <span class="json-schema-ref-array"> | |
| 5379 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
| 5380 | </span> | |
| 5381 | </div> | |
| 5382 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 5383 | </div> | |
| 5384 | <div class="prop-value"> | |
| 5385 | <p>successful operation</p> | |
| 5386 | </div> | |
| 5387 | </div> | |
| 5388 | <div class="prop-row prop-inner"> | |
| 5389 | <div class="prop-name">type</div> | |
| 5390 | <div class="prop-value"> | |
| 5391 | <span class="json-property-type"> | |
| 5392 | <span class="json-schema-ref-array"> | |
| 5393 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
| 5394 | </span> | |
| 5395 | </span> | |
| 5396 | <span class="json-property-range" title="Value limits"></span> | |
| 5397 | </div> | |
| 5398 | </div> | |
| 5399 | </section> | |
| 5400 | </div> | |
| 5401 | <div class="doc-examples"> | |
| 5402 | <h5>Response Content-Types: | |
| 5403 | <span>application/json</span> | |
| 5404 | </h5> | |
| 5405 | <section> | |
| 5406 | <h5>Response Example | |
| 5407 | <span>(200 OK)</span> | |
| 5408 | </h5> | |
| 5409 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 5410 | { | |
| 5411 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 5412 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 5413 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 5414 | <span class="hljs-attr">"ownerAccount"</span>: { | |
| 5415 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5416 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
| 5417 | } | |
| 5418 | } | |
| 5419 | ] | |
| 5420 | </code></pre> | |
| 5421 | <!-- </div> --> | |
| 5422 | </section> | |
| 5423 | </div> | |
| 5424 | </div> | |
| 5425 | </div> | |
| 5e1c08eb | 5426 | <h1 id="tag-VideoComment" class="swagger-summary-tag" data-traverse-target="tag-VideoComment">VideoComment</h1> |
| ab0ee6a1 | 5427 | <div id="operation--videos--videoId--comment-threads-get" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads-get"> |
| 5e1c08eb C |
5428 | <!-- <section class="operation-tags row"> --> |
| 5429 | <!-- <div class="doc-copy"> --> | |
| 5430 | <div class="operation-tags"> | |
| 5431 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
| 5432 | <!----> | |
| 5433 | </div> | |
| 5434 | <!-- </div> --> | |
| 5435 | <!-- </section> --> | |
| 5436 | <h2 class="operation-title"> | |
| 5437 | <span class="operation-name"> | |
| 5438 | <span class="operation-name">GET</span> | |
| ab0ee6a1 | 5439 | <span class="operation-path">/videos/{videoId}/comment-threads</span> |
| 5e1c08eb C |
5440 | </span> |
| 5441 | </h2> | |
| 5442 | <div class="doc-row"> | |
| 5443 | <div class="doc-copy"> | |
| 5444 | <section class="swagger-request-params"> | |
| 5445 | <div class="prop-row prop-group"> | |
| 5446 | <div class="prop-name"> | |
| ab0ee6a1 C |
5447 | <div class="prop-title">videoId</div> |
| 5448 | <span class="json-property-required"></span> | |
| 228e84aa C |
5449 | <div class="prop-subtitle"> in path </div> |
| 5450 | <div class="prop-subtitle"> | |
| 5451 | <span class="json-property-type">string</span> | |
| 5452 | <span class="json-property-range" title="Value limits"></span> | |
| 5453 | </div> | |
| ab0ee6a1 C |
5454 | </div> |
| 5455 | <div class="prop-value"> | |
| 5456 | <p>The video id </p> | |
| 5457 | </div> | |
| 5458 | </div> | |
| ab0ee6a1 C |
5459 | <div class="prop-row prop-group"> |
| 5460 | <div class="prop-name"> | |
| 5461 | <div class="prop-title">start</div> | |
| 228e84aa C |
5462 | <div class="prop-subtitle"> in query </div> |
| 5463 | <div class="prop-subtitle"> | |
| 5464 | <span class="json-property-type">number</span> | |
| 5465 | <span class="json-property-range" title="Value limits"></span> | |
| 5466 | </div> | |
| ab0ee6a1 C |
5467 | </div> |
| 5468 | <div class="prop-value"> | |
| 5469 | <p>starting page</p> | |
| 5470 | </div> | |
| 5471 | </div> | |
| ab0ee6a1 C |
5472 | <div class="prop-row prop-group"> |
| 5473 | <div class="prop-name"> | |
| 5474 | <div class="prop-title">stop</div> | |
| 228e84aa C |
5475 | <div class="prop-subtitle"> in query </div> |
| 5476 | <div class="prop-subtitle"> | |
| 5477 | <span class="json-property-type">number</span> | |
| 5478 | <span class="json-property-range" title="Value limits"></span> | |
| 5479 | </div> | |
| 5e1c08eb C |
5480 | </div> |
| 5481 | <div class="prop-value"> | |
| f209b32a | 5482 | <p>stopping page</p> |
| 5e1c08eb C |
5483 | </div> |
| 5484 | </div> | |
| ab0ee6a1 C |
5485 | <div class="prop-row prop-group"> |
| 5486 | <div class="prop-name"> | |
| 5487 | <div class="prop-title">sort</div> | |
| 228e84aa C |
5488 | <div class="prop-subtitle"> in query </div> |
| 5489 | <div class="prop-subtitle"> | |
| 5490 | <span class="json-property-type">number</span> | |
| 5491 | <span class="json-property-range" title="Value limits"></span> | |
| 5492 | </div> | |
| ab0ee6a1 C |
5493 | </div> |
| 5494 | <div class="prop-value"> | |
| 5495 | <p>sorting</p> | |
| 5496 | </div> | |
| 5497 | </div> | |
| 5e1c08eb C |
5498 | </section> |
| 5499 | </div> | |
| 5500 | <div class="doc-examples"></div> | |
| 5501 | </div> | |
| 5502 | <div class="doc-row"> | |
| 5503 | <div class="doc-copy"> | |
| 5504 | <section class="swagger-responses"> | |
| 5505 | <div class="prop-row prop-group"> | |
| 5506 | <div class="prop-name"> | |
| 5507 | <div class="prop-title">200 OK</div> | |
| 5508 | <div class="prop-ref"> | |
| 5509 | <span class=""> | |
| ab0ee6a1 | 5510 | <a class="json-schema-ref" href="#/definitions/CommentThreadResponse">CommentThreadResponse</a> |
| 5e1c08eb C |
5511 | </span> |
| 5512 | </div> | |
| 5513 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 5514 | </div> | |
| 5515 | <div class="prop-value"> | |
| 5516 | <p>successful operation</p> | |
| 5517 | </div> | |
| 5518 | </div> | |
| 5519 | </section> | |
| 5520 | </div> | |
| 5521 | <div class="doc-examples"> | |
| 5522 | <h5>Response Content-Types: | |
| 5523 | <span>application/json</span> | |
| 5524 | </h5> | |
| 5525 | <section> | |
| 5526 | <h5>Response Example | |
| 5527 | <span>(200 OK)</span> | |
| 5528 | </h5> | |
| ab0ee6a1 C |
5529 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ |
| 5530 | <span class="hljs-attr">"total"</span>: <span class="hljs-string">"number"</span>, | |
| 5531 | <span class="hljs-attr">"data"</span>: [ | |
| 5532 | { | |
| 5533 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5534 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 5535 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 5536 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 5537 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 5538 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 5539 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5540 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5541 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 5542 | <span class="hljs-attr">"account"</span>: { | |
| 5543 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 5544 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5545 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 5546 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 5547 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 5548 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 5549 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 5550 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 5551 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5552 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5553 | <span class="hljs-attr">"avatar"</span>: { | |
| 5554 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 5555 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5556 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 5557 | } | |
| 5558 | } | |
| 5559 | } | |
| 5560 | ] | |
| 5561 | } | |
| 5562 | </code></pre> | |
| 5e1c08eb C |
5563 | <!-- </div> --> |
| 5564 | </section> | |
| 5565 | </div> | |
| 5566 | </div> | |
| 5567 | </div> | |
| ab0ee6a1 | 5568 | <div id="operation--videos--videoId--comment-threads-post" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads-post"> |
| 5e1c08eb C |
5569 | <!-- <section class="operation-tags row"> --> |
| 5570 | <!-- <div class="doc-copy"> --> | |
| 5571 | <div class="operation-tags"> | |
| 5572 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
| 5573 | <!----> | |
| 5574 | </div> | |
| 5575 | <!-- </div> --> | |
| 5576 | <!-- </section> --> | |
| 5577 | <h2 class="operation-title"> | |
| 5578 | <span class="operation-name"> | |
| 5579 | <span class="operation-name">POST</span> | |
| ab0ee6a1 | 5580 | <span class="operation-path">/videos/{videoId}/comment-threads</span> |
| 5e1c08eb C |
5581 | </span> |
| 5582 | </h2> | |
| 5583 | <div class="doc-row"> | |
| 5584 | <div class="doc-copy"> | |
| 5585 | <section class="swagger-request-params"> | |
| 5586 | <div class="prop-row prop-group"> | |
| 5587 | <div class="prop-name"> | |
| 5588 | <div class="prop-title">videoId</div> | |
| 5589 | <span class="json-property-required"></span> | |
| 228e84aa C |
5590 | <div class="prop-subtitle"> in path </div> |
| 5591 | <div class="prop-subtitle"> | |
| 5592 | <span class="json-property-type">string</span> | |
| 5593 | <span class="json-property-range" title="Value limits"></span> | |
| 5594 | </div> | |
| 5e1c08eb C |
5595 | </div> |
| 5596 | <div class="prop-value"> | |
| 5597 | <p>The video id </p> | |
| 5598 | </div> | |
| 5599 | </div> | |
| 5e1c08eb C |
5600 | </section> |
| 5601 | </div> | |
| 5602 | <div class="doc-examples"></div> | |
| 5603 | </div> | |
| 5604 | <div class="doc-row"> | |
| 5605 | <div class="doc-copy"> | |
| 5606 | <section class="swagger-responses"> | |
| 5607 | <div class="prop-row prop-group"> | |
| 5608 | <div class="prop-name"> | |
| 5609 | <div class="prop-title">200 OK</div> | |
| ab0ee6a1 C |
5610 | <div class="prop-ref"> |
| 5611 | <span class=""> | |
| 5612 | <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a> | |
| 5613 | </span> | |
| 5614 | </div> | |
| 5615 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 5e1c08eb C |
5616 | </div> |
| 5617 | <div class="prop-value"> | |
| 5618 | <p>successful operation</p> | |
| 5619 | </div> | |
| 5620 | </div> | |
| 5621 | </section> | |
| 5622 | </div> | |
| 5623 | <div class="doc-examples"> | |
| 5624 | <h5>Response Content-Types: | |
| 5625 | <span>application/json</span> | |
| 5626 | </h5> | |
| ab0ee6a1 C |
5627 | <section> |
| 5628 | <h5>Response Example | |
| 5629 | <span>(200 OK)</span> | |
| 5630 | </h5> | |
| 5631 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 5632 | <span class="hljs-attr">"comment"</span>: { | |
| 5633 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5634 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 5635 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 5636 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 5637 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 5638 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 5639 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5640 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5641 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 5642 | <span class="hljs-attr">"account"</span>: { | |
| 5643 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 5644 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5645 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 5646 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 5647 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 5648 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 5649 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 5650 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 5651 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5652 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5653 | <span class="hljs-attr">"avatar"</span>: { | |
| 5654 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 5655 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5656 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 5657 | } | |
| 5658 | } | |
| 5659 | } | |
| 5660 | } | |
| 5661 | </code></pre> | |
| 5662 | <!-- </div> --> | |
| 5663 | </section> | |
| 5e1c08eb C |
5664 | </div> |
| 5665 | </div> | |
| 94ff4c23 C |
5666 | <div class="doc-row"> |
| 5667 | <div class="doc-copy"> | |
| 5668 | <section class="swagger-request-security"> | |
| 5669 | <table class="table"> | |
| 5670 | <thead> | |
| 5671 | <tr> | |
| 5672 | <th class="swagger-request-security-schema"></th> | |
| 5673 | <th class="swagger-request-security-scopes"></th> | |
| 5674 | </tr> | |
| 5675 | </thead> | |
| 5676 | <tbody> | |
| 5677 | <tr> | |
| 5678 | <td> | |
| 5679 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 5680 | </td> | |
| 5681 | <td> </td> | |
| 5682 | </tr> | |
| 5683 | </tbody> | |
| 5684 | </table> | |
| 5685 | </section> | |
| 5686 | </div> | |
| 5687 | </div> | |
| 5e1c08eb | 5688 | </div> |
| ab0ee6a1 | 5689 | <div id="operation--videos--videoId--comment-threads--threadId--get" class="operation panel" data-traverse-target="operation--videos--videoId--comment-threads--threadId--get"> |
| 5e1c08eb C |
5690 | <!-- <section class="operation-tags row"> --> |
| 5691 | <!-- <div class="doc-copy"> --> | |
| 5692 | <div class="operation-tags"> | |
| 5693 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
| 5694 | <!----> | |
| 5695 | </div> | |
| 5696 | <!-- </div> --> | |
| 5697 | <!-- </section> --> | |
| 5698 | <h2 class="operation-title"> | |
| 5699 | <span class="operation-name"> | |
| 5700 | <span class="operation-name">GET</span> | |
| ab0ee6a1 | 5701 | <span class="operation-path">/videos/{videoId}/comment-threads/{threadId}</span> |
| 5e1c08eb C |
5702 | </span> |
| 5703 | </h2> | |
| 5704 | <div class="doc-row"> | |
| 5705 | <div class="doc-copy"> | |
| 5706 | <section class="swagger-request-params"> | |
| 5707 | <div class="prop-row prop-group"> | |
| 5708 | <div class="prop-name"> | |
| 5709 | <div class="prop-title">videoId</div> | |
| 5710 | <span class="json-property-required"></span> | |
| 228e84aa C |
5711 | <div class="prop-subtitle"> in path </div> |
| 5712 | <div class="prop-subtitle"> | |
| 5713 | <span class="json-property-type">string</span> | |
| 5714 | <span class="json-property-range" title="Value limits"></span> | |
| 5715 | </div> | |
| 5e1c08eb C |
5716 | </div> |
| 5717 | <div class="prop-value"> | |
| 5718 | <p>The video id </p> | |
| 5719 | </div> | |
| 5720 | </div> | |
| 5e1c08eb C |
5721 | <div class="prop-row prop-group"> |
| 5722 | <div class="prop-name"> | |
| 5723 | <div class="prop-title">threadId</div> | |
| 5724 | <span class="json-property-required"></span> | |
| 228e84aa C |
5725 | <div class="prop-subtitle"> in path </div> |
| 5726 | <div class="prop-subtitle"> | |
| 5727 | <span class="json-property-type">string</span> | |
| 5728 | <span class="json-property-range" title="Value limits"></span> | |
| 5729 | </div> | |
| 5e1c08eb C |
5730 | </div> |
| 5731 | <div class="prop-value"> | |
| 5732 | <p>The thread id </p> | |
| 5733 | </div> | |
| 5734 | </div> | |
| 5e1c08eb C |
5735 | </section> |
| 5736 | </div> | |
| 5737 | <div class="doc-examples"></div> | |
| 5738 | </div> | |
| 5739 | <div class="doc-row"> | |
| 5740 | <div class="doc-copy"> | |
| 5741 | <section class="swagger-responses"> | |
| 5742 | <div class="prop-row prop-group"> | |
| 5743 | <div class="prop-name"> | |
| 5744 | <div class="prop-title">200 OK</div> | |
| 5745 | <div class="prop-ref"> | |
| 5746 | <span class=""> | |
| 5747 | <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a> | |
| 5748 | </span> | |
| 5749 | </div> | |
| 5750 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 5751 | </div> | |
| 5752 | <div class="prop-value"> | |
| 5753 | <p>successful operation</p> | |
| 5754 | </div> | |
| 5755 | </div> | |
| 5756 | </section> | |
| 5757 | </div> | |
| 5758 | <div class="doc-examples"> | |
| 5759 | <h5>Response Content-Types: | |
| 5760 | <span>application/json</span> | |
| 5761 | </h5> | |
| 5762 | <section> | |
| 5763 | <h5>Response Example | |
| 5764 | <span>(200 OK)</span> | |
| 5765 | </h5> | |
| 5766 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 5767 | <span class="hljs-attr">"comment"</span>: { | |
| 5768 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5769 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 5770 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 5771 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 5772 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 5773 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 5774 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5775 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5776 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 5777 | <span class="hljs-attr">"account"</span>: { | |
| 5778 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 5779 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5780 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 5781 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 5782 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 5783 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 5784 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 5785 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 5786 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5787 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5788 | <span class="hljs-attr">"avatar"</span>: { | |
| 5789 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 5790 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5791 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 5792 | } | |
| 5793 | } | |
| 5794 | }, | |
| 5795 | <span class="hljs-attr">"children"</span>: [ | |
| 5796 | { | |
| 5797 | <span class="hljs-attr">"comment"</span>: { | |
| 5798 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5799 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 5800 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 5801 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 5802 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 5803 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 5804 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5805 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5806 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 5807 | <span class="hljs-attr">"account"</span>: { | |
| 5808 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 5809 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5810 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 5811 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 5812 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 5813 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 5814 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 5815 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 5816 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5817 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5818 | <span class="hljs-attr">"avatar"</span>: { | |
| 5819 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 5820 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5821 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 5822 | } | |
| 5823 | } | |
| 5824 | }, | |
| 5825 | <span class="hljs-attr">"children"</span>: [ | |
| 5826 | { | |
| 5827 | <span class="hljs-attr">"comment"</span>: { | |
| 5828 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5829 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 5830 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 5831 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 5832 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 5833 | <span class="hljs-attr">"videoId"</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">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 5837 | <span class="hljs-attr">"account"</span>: { | |
| 5838 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5839 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 5840 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 5841 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 5842 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 5843 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 5844 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 5845 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5846 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5847 | <span class="hljs-attr">"avatar"</span>: { | |
| 5848 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 5849 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5850 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 5851 | } | |
| 5852 | } | |
| 5853 | } | |
| 5854 | } | |
| 5855 | ] | |
| 5856 | } | |
| 5857 | ] | |
| 5858 | } | |
| 5859 | </code></pre> | |
| 5860 | <!-- </div> --> | |
| 5861 | </section> | |
| 5862 | </div> | |
| 5863 | </div> | |
| 5864 | </div> | |
| ab0ee6a1 | 5865 | <div id="operation--videos--videoId--comments--commentId--post" class="operation panel" data-traverse-target="operation--videos--videoId--comments--commentId--post"> |
| 5e1c08eb C |
5866 | <!-- <section class="operation-tags row"> --> |
| 5867 | <!-- <div class="doc-copy"> --> | |
| 5868 | <div class="operation-tags"> | |
| 5869 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
| 5870 | <!----> | |
| 5871 | </div> | |
| 5872 | <!-- </div> --> | |
| 5873 | <!-- </section> --> | |
| 5874 | <h2 class="operation-title"> | |
| 5875 | <span class="operation-name"> | |
| 5876 | <span class="operation-name">POST</span> | |
| ab0ee6a1 | 5877 | <span class="operation-path">/videos/{videoId}/comments/{commentId}</span> |
| 5e1c08eb C |
5878 | </span> |
| 5879 | </h2> | |
| 5880 | <div class="doc-row"> | |
| 5881 | <div class="doc-copy"> | |
| 5882 | <section class="swagger-request-params"> | |
| 5883 | <div class="prop-row prop-group"> | |
| 5884 | <div class="prop-name"> | |
| 5885 | <div class="prop-title">videoId</div> | |
| 5886 | <span class="json-property-required"></span> | |
| 228e84aa C |
5887 | <div class="prop-subtitle"> in path </div> |
| 5888 | <div class="prop-subtitle"> | |
| 5889 | <span class="json-property-type">string</span> | |
| 5890 | <span class="json-property-range" title="Value limits"></span> | |
| 5891 | </div> | |
| 5e1c08eb C |
5892 | </div> |
| 5893 | <div class="prop-value"> | |
| 5894 | <p>The video id </p> | |
| 5895 | </div> | |
| 5896 | </div> | |
| 5e1c08eb C |
5897 | <div class="prop-row prop-group"> |
| 5898 | <div class="prop-name"> | |
| 5899 | <div class="prop-title">commentId</div> | |
| 5900 | <span class="json-property-required"></span> | |
| 228e84aa C |
5901 | <div class="prop-subtitle"> in path </div> |
| 5902 | <div class="prop-subtitle"> | |
| 5903 | <span class="json-property-type">string</span> | |
| 5904 | <span class="json-property-range" title="Value limits"></span> | |
| 5905 | </div> | |
| 5e1c08eb C |
5906 | </div> |
| 5907 | <div class="prop-value"> | |
| 5908 | <p>The comment id </p> | |
| 5909 | </div> | |
| 5910 | </div> | |
| 5e1c08eb C |
5911 | </section> |
| 5912 | </div> | |
| 5913 | <div class="doc-examples"></div> | |
| 5914 | </div> | |
| 5915 | <div class="doc-row"> | |
| 5916 | <div class="doc-copy"> | |
| 5917 | <section class="swagger-responses"> | |
| 5918 | <div class="prop-row prop-group"> | |
| 5919 | <div class="prop-name"> | |
| 5920 | <div class="prop-title">200 OK</div> | |
| ab0ee6a1 C |
5921 | <div class="prop-ref"> |
| 5922 | <span class=""> | |
| 5923 | <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a> | |
| 5924 | </span> | |
| 5925 | </div> | |
| 5926 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 5e1c08eb C |
5927 | </div> |
| 5928 | <div class="prop-value"> | |
| 5929 | <p>successful operation</p> | |
| 5930 | </div> | |
| 5931 | </div> | |
| 5932 | </section> | |
| 5933 | </div> | |
| 5934 | <div class="doc-examples"> | |
| 5935 | <h5>Response Content-Types: | |
| 5936 | <span>application/json</span> | |
| 5937 | </h5> | |
| ab0ee6a1 C |
5938 | <section> |
| 5939 | <h5>Response Example | |
| 5940 | <span>(200 OK)</span> | |
| 5941 | </h5> | |
| 5942 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 5943 | <span class="hljs-attr">"comment"</span>: { | |
| 5944 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5945 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 5946 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 5947 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 5948 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 5949 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 5950 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5951 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5952 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 5953 | <span class="hljs-attr">"account"</span>: { | |
| 5954 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 5955 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5956 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 5957 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 5958 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 5959 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 5960 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 5961 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 5962 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5963 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5964 | <span class="hljs-attr">"avatar"</span>: { | |
| 5965 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 5966 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5967 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 5968 | } | |
| 5969 | } | |
| 5970 | } | |
| 5971 | } | |
| 5972 | </code></pre> | |
| 5973 | <!-- </div> --> | |
| 5974 | </section> | |
| 5e1c08eb C |
5975 | </div> |
| 5976 | </div> | |
| 94ff4c23 C |
5977 | <div class="doc-row"> |
| 5978 | <div class="doc-copy"> | |
| 5979 | <section class="swagger-request-security"> | |
| 5980 | <table class="table"> | |
| 5981 | <thead> | |
| 5982 | <tr> | |
| 5983 | <th class="swagger-request-security-schema"></th> | |
| 5984 | <th class="swagger-request-security-scopes"></th> | |
| 5985 | </tr> | |
| 5986 | </thead> | |
| 5987 | <tbody> | |
| 5988 | <tr> | |
| 5989 | <td> | |
| 5990 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 5991 | </td> | |
| 5992 | <td> </td> | |
| 5993 | </tr> | |
| 5994 | </tbody> | |
| 5995 | </table> | |
| 5996 | </section> | |
| 5997 | </div> | |
| 5998 | </div> | |
| 5e1c08eb | 5999 | </div> |
| ab0ee6a1 | 6000 | <div id="operation--videos--videoId--comments--commentId--delete" class="operation panel" data-traverse-target="operation--videos--videoId--comments--commentId--delete"> |
| 5e1c08eb C |
6001 | <!-- <section class="operation-tags row"> --> |
| 6002 | <!-- <div class="doc-copy"> --> | |
| 6003 | <div class="operation-tags"> | |
| 6004 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
| 6005 | <!----> | |
| 6006 | </div> | |
| 6007 | <!-- </div> --> | |
| 6008 | <!-- </section> --> | |
| 6009 | <h2 class="operation-title"> | |
| 6010 | <span class="operation-name"> | |
| 6011 | <span class="operation-name">DELETE</span> | |
| ab0ee6a1 | 6012 | <span class="operation-path">/videos/{videoId}/comments/{commentId}</span> |
| 5e1c08eb C |
6013 | </span> |
| 6014 | </h2> | |
| 6015 | <div class="doc-row"> | |
| 6016 | <div class="doc-copy"> | |
| 6017 | <section class="swagger-request-params"> | |
| 6018 | <div class="prop-row prop-group"> | |
| 6019 | <div class="prop-name"> | |
| 6020 | <div class="prop-title">videoId</div> | |
| 6021 | <span class="json-property-required"></span> | |
| 228e84aa C |
6022 | <div class="prop-subtitle"> in path </div> |
| 6023 | <div class="prop-subtitle"> | |
| 6024 | <span class="json-property-type">string</span> | |
| 6025 | <span class="json-property-range" title="Value limits"></span> | |
| 6026 | </div> | |
| 5e1c08eb C |
6027 | </div> |
| 6028 | <div class="prop-value"> | |
| 6029 | <p>The video id </p> | |
| 6030 | </div> | |
| 6031 | </div> | |
| 5e1c08eb C |
6032 | <div class="prop-row prop-group"> |
| 6033 | <div class="prop-name"> | |
| 6034 | <div class="prop-title">commentId</div> | |
| 6035 | <span class="json-property-required"></span> | |
| 228e84aa C |
6036 | <div class="prop-subtitle"> in path </div> |
| 6037 | <div class="prop-subtitle"> | |
| 6038 | <span class="json-property-type">string</span> | |
| 6039 | <span class="json-property-range" title="Value limits"></span> | |
| 6040 | </div> | |
| 5e1c08eb C |
6041 | </div> |
| 6042 | <div class="prop-value"> | |
| 6043 | <p>The comment id </p> | |
| 6044 | </div> | |
| 6045 | </div> | |
| 5e1c08eb C |
6046 | </section> |
| 6047 | </div> | |
| 6048 | <div class="doc-examples"></div> | |
| 6049 | </div> | |
| 6050 | <div class="doc-row"> | |
| 6051 | <div class="doc-copy"> | |
| 6052 | <section class="swagger-responses"> | |
| 6053 | <div class="prop-row prop-group"> | |
| 6054 | <div class="prop-name"> | |
| 6055 | <div class="prop-title">204 No Content</div> | |
| 6056 | </div> | |
| 6057 | <div class="prop-value"> | |
| 6058 | <p>successful operation</p> | |
| 6059 | </div> | |
| 6060 | </div> | |
| 6061 | </section> | |
| 6062 | </div> | |
| 6063 | <div class="doc-examples"> | |
| 6064 | <h5>Response Content-Types: | |
| 6065 | <span>application/json</span> | |
| 6066 | </h5> | |
| 6067 | </div> | |
| 6068 | </div> | |
| 94ff4c23 C |
6069 | <div class="doc-row"> |
| 6070 | <div class="doc-copy"> | |
| 6071 | <section class="swagger-request-security"> | |
| 6072 | <table class="table"> | |
| 6073 | <thead> | |
| 6074 | <tr> | |
| 6075 | <th class="swagger-request-security-schema"></th> | |
| 6076 | <th class="swagger-request-security-scopes"></th> | |
| 6077 | </tr> | |
| 6078 | </thead> | |
| 6079 | <tbody> | |
| 6080 | <tr> | |
| 6081 | <td> | |
| 6082 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 6083 | </td> | |
| 6084 | <td> </td> | |
| 6085 | </tr> | |
| 6086 | </tbody> | |
| 6087 | </table> | |
| 6088 | </section> | |
| 6089 | </div> | |
| 6090 | </div> | |
| 5e1c08eb C |
6091 | </div> |
| 6092 | <h1 id="tag-VideoRate" class="swagger-summary-tag" data-traverse-target="tag-VideoRate">VideoRate</h1> | |
| ab0ee6a1 | 6093 | <div id="operation--videos--id--rate-put" class="operation panel" data-traverse-target="operation--videos--id--rate-put"> |
| 5e1c08eb C |
6094 | <!-- <section class="operation-tags row"> --> |
| 6095 | <!-- <div class="doc-copy"> --> | |
| 6096 | <div class="operation-tags"> | |
| 6097 | <a class="label" href="#tag-VideoRate">VideoRate</a> | |
| 6098 | <!----> | |
| 6099 | </div> | |
| 6100 | <!-- </div> --> | |
| 6101 | <!-- </section> --> | |
| 6102 | <h2 class="operation-title"> | |
| 6103 | <span class="operation-name"> | |
| 6104 | <span class="operation-name">PUT</span> | |
| ab0ee6a1 | 6105 | <span class="operation-path">/videos/{id}/rate</span> |
| 5e1c08eb C |
6106 | </span> |
| 6107 | </h2> | |
| 6108 | <div class="doc-row"> | |
| 6109 | <div class="doc-copy"> | |
| 6110 | <section class="swagger-request-params"> | |
| 6111 | <div class="prop-row prop-group"> | |
| 6112 | <div class="prop-name"> | |
| 6113 | <div class="prop-title">id</div> | |
| 6114 | <span class="json-property-required"></span> | |
| 228e84aa C |
6115 | <div class="prop-subtitle"> in path </div> |
| 6116 | <div class="prop-subtitle"> | |
| 6117 | <span class="json-property-type">string</span> | |
| 6118 | <span class="json-property-range" title="Value limits"></span> | |
| 6119 | </div> | |
| 5e1c08eb C |
6120 | </div> |
| 6121 | <div class="prop-value"> | |
| 6122 | <p>The video id </p> | |
| 6123 | </div> | |
| 6124 | </div> | |
| 5e1c08eb C |
6125 | </section> |
| 6126 | </div> | |
| 6127 | <div class="doc-examples"></div> | |
| 6128 | </div> | |
| 6129 | <div class="doc-row"> | |
| 6130 | <div class="doc-copy"> | |
| 6131 | <section class="swagger-responses"> | |
| 6132 | <div class="prop-row prop-group"> | |
| 6133 | <div class="prop-name"> | |
| 6134 | <div class="prop-title">204 No Content</div> | |
| 6135 | </div> | |
| 6136 | <div class="prop-value"> | |
| 6137 | <p>successful operation</p> | |
| 6138 | </div> | |
| 6139 | </div> | |
| 6140 | </section> | |
| 6141 | </div> | |
| 6142 | <div class="doc-examples"> | |
| 6143 | <h5>Response Content-Types: | |
| 6144 | <span>application/json</span> | |
| 6145 | </h5> | |
| 6146 | </div> | |
| 6147 | </div> | |
| 94ff4c23 C |
6148 | <div class="doc-row"> |
| 6149 | <div class="doc-copy"> | |
| 6150 | <section class="swagger-request-security"> | |
| 6151 | <table class="table"> | |
| 6152 | <thead> | |
| 6153 | <tr> | |
| 6154 | <th class="swagger-request-security-schema"></th> | |
| 6155 | <th class="swagger-request-security-scopes"></th> | |
| 6156 | </tr> | |
| 6157 | </thead> | |
| 6158 | <tbody> | |
| 6159 | <tr> | |
| 6160 | <td> | |
| 6161 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 6162 | </td> | |
| 6163 | <td> </td> | |
| 6164 | </tr> | |
| 6165 | </tbody> | |
| 6166 | </table> | |
| 6167 | </section> | |
| 6168 | </div> | |
| 6169 | </div> | |
| 5e1c08eb C |
6170 | </div> |
| 6171 | <h1>Schema Definitions</h1> | |
| 48dce1c9 | 6172 | <div id="definition-VideoConstantNumber" class="definition panel" data-traverse-target="definition-VideoConstantNumber"> |
| 5d00a3d7 | 6173 | <h2 class="panel-title"> |
| 48dce1c9 | 6174 | <a name="/definitions/VideoConstantNumber"></a>VideoConstantNumber: |
| 5d00a3d7 C |
6175 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 6176 | <span class="json-property-range" title="Value limits"></span> | |
| 6177 | ||
| 6178 | ||
| 6179 | </span> --> | |
| 6180 | </h2> | |
| 6181 | <div class="doc-row"> | |
| 6182 | <div class="doc-copy"> | |
| 6183 | <section class="json-schema-properties"> | |
| 6184 | <dl> | |
| 6185 | <dt data-property-name="id"> | |
| 6186 | <span class="json-property-name">id:</span> | |
| 6187 | <span class="json-property-type">number</span> | |
| 6188 | <span class="json-property-range" title="Value limits"></span> | |
| 6189 | </dt> | |
| 6190 | <dt data-property-name="label"> | |
| 6191 | <span class="json-property-name">label:</span> | |
| 6192 | <span class="json-property-type">string</span> | |
| 6193 | <span class="json-property-range" title="Value limits"></span> | |
| 6194 | </dt> | |
| 6195 | </dl> | |
| 6196 | </section> | |
| 6197 | </div> | |
| 6198 | <div class="doc-examples"> | |
| 6199 | <section> | |
| 6200 | <h5>Example</h5> | |
| 6201 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 6202 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 6203 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 6204 | } | |
| 48dce1c9 C |
6205 | </code></pre> |
| 6206 | <!-- </div> --> | |
| 6207 | </section> | |
| 6208 | </div> | |
| 6209 | </div> | |
| 6210 | </div> | |
| 6211 | <div id="definition-VideoConstantString" class="definition panel" data-traverse-target="definition-VideoConstantString"> | |
| 6212 | <h2 class="panel-title"> | |
| 6213 | <a name="/definitions/VideoConstantString"></a>VideoConstantString: | |
| 6214 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 6215 | <span class="json-property-range" title="Value limits"></span> | |
| 6216 | ||
| 6217 | ||
| 6218 | </span> --> | |
| 6219 | </h2> | |
| 6220 | <div class="doc-row"> | |
| 6221 | <div class="doc-copy"> | |
| 6222 | <section class="json-schema-properties"> | |
| 6223 | <dl> | |
| 6224 | <dt data-property-name="id"> | |
| 6225 | <span class="json-property-name">id:</span> | |
| 6226 | <span class="json-property-type">string</span> | |
| 6227 | <span class="json-property-range" title="Value limits"></span> | |
| 6228 | </dt> | |
| 6229 | <dt data-property-name="label"> | |
| 6230 | <span class="json-property-name">label:</span> | |
| 6231 | <span class="json-property-type">string</span> | |
| 6232 | <span class="json-property-range" title="Value limits"></span> | |
| 6233 | </dt> | |
| 6234 | </dl> | |
| 6235 | </section> | |
| 6236 | </div> | |
| 6237 | <div class="doc-examples"> | |
| 6238 | <section> | |
| 6239 | <h5>Example</h5> | |
| 6240 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 6241 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
| 6242 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 6243 | } | |
| 5d00a3d7 C |
6244 | </code></pre> |
| 6245 | <!-- </div> --> | |
| 6246 | </section> | |
| 6247 | </div> | |
| 6248 | </div> | |
| 6249 | </div> | |
| 61b66b36 C |
6250 | <div id="definition-VideoPrivacy" class="definition panel" data-traverse-target="definition-VideoPrivacy"> |
| 6251 | <h2 class="panel-title"> | |
| 6252 | <a name="/definitions/VideoPrivacy"></a>VideoPrivacy: string | |
| 6253 | <!-- <span class="json-property-type"><span class="json-property-type">string</span> <span class="json-property-enum" title="Possible values"> | |
| 6254 | <span class="json-property-enum-item">Public</span>, | |
| 6255 | <span class="json-property-enum-item">Unlisted</span>, | |
| 6256 | <span class="json-property-enum-item">Private</span> | |
| 6257 | </span> | |
| 6258 | <span class="json-property-range" title="Value limits"></span> | |
| 6259 | ||
| 6260 | ||
| 6261 | </span> --> | |
| 6262 | </h2> | |
| 6263 | <div class="doc-row"> | |
| 6264 | <div class="doc-copy"> | |
| 6265 | <span class="json-property-type">string</span> | |
| 6266 | <span class="json-property-enum" title="Possible values"> | |
| 6267 | <span class="json-property-enum-item">Public</span>, | |
| 6268 | <span class="json-property-enum-item">Unlisted</span>, | |
| 6269 | <span class="json-property-enum-item">Private</span> | |
| 6270 | </span> | |
| 6271 | <span class="json-property-range" title="Value limits"></span> | |
| 6272 | </div> | |
| 6273 | </div> | |
| 6274 | </div> | |
| 5e1c08eb C |
6275 | <div id="definition-Video" class="definition panel" data-traverse-target="definition-Video"> |
| 6276 | <h2 class="panel-title"> | |
| 6277 | <a name="/definitions/Video"></a>Video: | |
| 6278 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 6279 | <span class="json-property-range" title="Value limits"></span> | |
| 6280 | ||
| 6281 | ||
| 6282 | </span> --> | |
| 6283 | </h2> | |
| 6284 | <div class="doc-row"> | |
| 6285 | <div class="doc-copy"> | |
| 6286 | <section class="json-schema-properties"> | |
| 6287 | <dl> | |
| 6288 | <dt data-property-name="id"> | |
| 6289 | <span class="json-property-name">id:</span> | |
| 6290 | <span class="json-property-type">number</span> | |
| 6291 | <span class="json-property-range" title="Value limits"></span> | |
| 6292 | </dt> | |
| 6293 | <dt data-property-name="uuid"> | |
| 6294 | <span class="json-property-name">uuid:</span> | |
| 6295 | <span class="json-property-type">string</span> | |
| 6296 | <span class="json-property-range" title="Value limits"></span> | |
| 6297 | </dt> | |
| 5e1c08eb C |
6298 | <dt data-property-name="createdAt"> |
| 6299 | <span class="json-property-name">createdAt:</span> | |
| 6300 | <span class="json-property-type">string</span> | |
| 6301 | <span class="json-property-range" title="Value limits"></span> | |
| 6302 | </dt> | |
| 61b66b36 C |
6303 | <dt data-property-name="publishedAt"> |
| 6304 | <span class="json-property-name">publishedAt:</span> | |
| 6305 | <span class="json-property-type">string</span> | |
| 6306 | <span class="json-property-range" title="Value limits"></span> | |
| 6307 | </dt> | |
| 5e1c08eb C |
6308 | <dt data-property-name="updatedAt"> |
| 6309 | <span class="json-property-name">updatedAt:</span> | |
| 6310 | <span class="json-property-type">string</span> | |
| 6311 | <span class="json-property-range" title="Value limits"></span> | |
| 6312 | </dt> | |
| 5e1c08eb C |
6313 | <dt data-property-name="category"> |
| 6314 | <span class="json-property-name">category:</span> | |
| 5d00a3d7 C |
6315 | <span class="json-property-type"> |
| 6316 | <span class=""> | |
| 48dce1c9 | 6317 | <a class="json-schema-ref" href="#/definitions/VideoConstantNumber">VideoConstantNumber</a> |
| 5d00a3d7 C |
6318 | </span> |
| 6319 | </span> | |
| 5e1c08eb C |
6320 | <span class="json-property-range" title="Value limits"></span> |
| 6321 | </dt> | |
| 6322 | <dt data-property-name="licence"> | |
| 6323 | <span class="json-property-name">licence:</span> | |
| 5d00a3d7 C |
6324 | <span class="json-property-type"> |
| 6325 | <span class=""> | |
| 48dce1c9 | 6326 | <a class="json-schema-ref" href="#/definitions/VideoConstantNumber">VideoConstantNumber</a> |
| 5d00a3d7 C |
6327 | </span> |
| 6328 | </span> | |
| 5e1c08eb C |
6329 | <span class="json-property-range" title="Value limits"></span> |
| 6330 | </dt> | |
| 6331 | <dt data-property-name="language"> | |
| 6332 | <span class="json-property-name">language:</span> | |
| 5d00a3d7 C |
6333 | <span class="json-property-type"> |
| 6334 | <span class=""> | |
| 48dce1c9 | 6335 | <a class="json-schema-ref" href="#/definitions/VideoConstantString">VideoConstantString</a> |
| 5d00a3d7 C |
6336 | </span> |
| 6337 | </span> | |
| 5e1c08eb C |
6338 | <span class="json-property-range" title="Value limits"></span> |
| 6339 | </dt> | |
| 61b66b36 C |
6340 | <dt data-property-name="privacy"> |
| 6341 | <span class="json-property-name">privacy:</span> | |
| 6342 | <span class="json-property-type"> | |
| 6343 | <span class=""> | |
| 6344 | <a class="json-schema-ref" href="#/definitions/VideoPrivacy">VideoPrivacy</a> | |
| 6345 | </span> | |
| 6346 | </span> | |
| 6347 | <span class="json-property-range" title="Value limits"></span> | |
| 6348 | </dt> | |
| 5e1c08eb C |
6349 | <dt data-property-name="description"> |
| 6350 | <span class="json-property-name">description:</span> | |
| 6351 | <span class="json-property-type">string</span> | |
| 6352 | <span class="json-property-range" title="Value limits"></span> | |
| 6353 | </dt> | |
| 6354 | <dt data-property-name="duration"> | |
| 6355 | <span class="json-property-name">duration:</span> | |
| 6356 | <span class="json-property-type">number</span> | |
| 6357 | <span class="json-property-range" title="Value limits"></span> | |
| 6358 | </dt> | |
| 6359 | <dt data-property-name="isLocal"> | |
| 6360 | <span class="json-property-name">isLocal:</span> | |
| 6361 | <span class="json-property-type">boolean</span> | |
| 6362 | <span class="json-property-range" title="Value limits"></span> | |
| 6363 | </dt> | |
| 6364 | <dt data-property-name="name"> | |
| 6365 | <span class="json-property-name">name:</span> | |
| 6366 | <span class="json-property-type">string</span> | |
| 6367 | <span class="json-property-range" title="Value limits"></span> | |
| 6368 | </dt> | |
| 5e1c08eb C |
6369 | <dt data-property-name="thumbnailPath"> |
| 6370 | <span class="json-property-name">thumbnailPath:</span> | |
| 6371 | <span class="json-property-type">string</span> | |
| 6372 | <span class="json-property-range" title="Value limits"></span> | |
| 6373 | </dt> | |
| 6374 | <dt data-property-name="previewPath"> | |
| 6375 | <span class="json-property-name">previewPath:</span> | |
| 6376 | <span class="json-property-type">string</span> | |
| 6377 | <span class="json-property-range" title="Value limits"></span> | |
| 6378 | </dt> | |
| 6379 | <dt data-property-name="embedPath"> | |
| 6380 | <span class="json-property-name">embedPath:</span> | |
| 6381 | <span class="json-property-type">string</span> | |
| 6382 | <span class="json-property-range" title="Value limits"></span> | |
| 6383 | </dt> | |
| 6384 | <dt data-property-name="views"> | |
| 6385 | <span class="json-property-name">views:</span> | |
| 6386 | <span class="json-property-type">number</span> | |
| 6387 | <span class="json-property-range" title="Value limits"></span> | |
| 6388 | </dt> | |
| 6389 | <dt data-property-name="likes"> | |
| 6390 | <span class="json-property-name">likes:</span> | |
| 6391 | <span class="json-property-type">number</span> | |
| 6392 | <span class="json-property-range" title="Value limits"></span> | |
| 6393 | </dt> | |
| 6394 | <dt data-property-name="dislikes"> | |
| 6395 | <span class="json-property-name">dislikes:</span> | |
| 6396 | <span class="json-property-type">number</span> | |
| 6397 | <span class="json-property-range" title="Value limits"></span> | |
| 6398 | </dt> | |
| 6399 | <dt data-property-name="nsfw"> | |
| 6400 | <span class="json-property-name">nsfw:</span> | |
| 6401 | <span class="json-property-type">boolean</span> | |
| 6402 | <span class="json-property-range" title="Value limits"></span> | |
| 6403 | </dt> | |
| 5d00a3d7 C |
6404 | <dt data-property-name="account"> |
| 6405 | <span class="json-property-name">account:</span> | |
| 6406 | <span class="json-property-type">object</span> | |
| 6407 | <span class="json-property-range" title="Value limits"></span> | |
| 6408 | </dt> | |
| ad9e39fb C |
6409 | <dt class="json-inner-schema"> |
| 6410 | <section class="json-schema-properties"> | |
| 6411 | <dl> | |
| 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> | |
| 6417 | <dt data-property-name="displayName"> | |
| 6418 | <span class="json-property-name">displayName:</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="url"> | |
| 6423 | <span class="json-property-name">url:</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="host"> | |
| 6428 | <span class="json-property-name">host:</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="avatar"> | |
| 6433 | <span class="json-property-name">avatar:</span> | |
| 6434 | <span class="json-property-type"> | |
| 6435 | <span class=""> | |
| 6436 | <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a> | |
| 6437 | </span> | |
| 6438 | </span> | |
| 6439 | <span class="json-property-range" title="Value limits"></span> | |
| 6440 | </dt> | |
| 6441 | </dl> | |
| 6442 | </section> | |
| 6443 | </dt> | |
| 5e1c08eb C |
6444 | </dl> |
| 6445 | </section> | |
| 6446 | </div> | |
| 6447 | <div class="doc-examples"> | |
| 6448 | <section> | |
| 6449 | <h5>Example</h5> | |
| 6450 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 6451 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 6452 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 5e1c08eb | 6453 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
| 61b66b36 | 6454 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb | 6455 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, |
| 5d00a3d7 C |
6456 | <span class="hljs-attr">"category"</span>: { |
| 6457 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 6458 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 6459 | }, | |
| 6460 | <span class="hljs-attr">"licence"</span>: { | |
| 6461 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 6462 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 6463 | }, | |
| 6464 | <span class="hljs-attr">"language"</span>: { | |
| 48dce1c9 | 6465 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
| 5d00a3d7 C |
6466 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
| 6467 | }, | |
| 61b66b36 | 6468 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb C |
6469 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
| 6470 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 6471 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 6472 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 5e1c08eb C |
6473 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
| 6474 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
| 6475 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
| 6476 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 6477 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 6478 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 61b66b36 C |
6479 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, |
| 6480 | <span class="hljs-attr">"account"</span>: { | |
| 6481 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 6482 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 6483 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 6484 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 6485 | <span class="hljs-attr">"avatar"</span>: { | |
| 6486 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 6487 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6488 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 6489 | } | |
| 6490 | } | |
| 5e1c08eb C |
6491 | } |
| 6492 | </code></pre> | |
| 6493 | <!-- </div> --> | |
| 6494 | </section> | |
| 6495 | </div> | |
| 6496 | </div> | |
| 6497 | </div> | |
| 6498 | <div id="definition-VideoAbuse" class="definition panel" data-traverse-target="definition-VideoAbuse"> | |
| 6499 | <h2 class="panel-title"> | |
| 6500 | <a name="/definitions/VideoAbuse"></a>VideoAbuse: | |
| 6501 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 6502 | <span class="json-property-range" title="Value limits"></span> | |
| 6503 | ||
| 6504 | ||
| 6505 | </span> --> | |
| 6506 | </h2> | |
| 6507 | <div class="doc-row"> | |
| 6508 | <div class="doc-copy"> | |
| 6509 | <section class="json-schema-properties"> | |
| 6510 | <dl> | |
| 6511 | <dt data-property-name="id"> | |
| 6512 | <span class="json-property-name">id:</span> | |
| 6513 | <span class="json-property-type">number</span> | |
| 6514 | <span class="json-property-range" title="Value limits"></span> | |
| 6515 | </dt> | |
| 6516 | <dt data-property-name="reason"> | |
| 6517 | <span class="json-property-name">reason:</span> | |
| 6518 | <span class="json-property-type">string</span> | |
| 6519 | <span class="json-property-range" title="Value limits"></span> | |
| 6520 | </dt> | |
| 5d00a3d7 C |
6521 | <dt data-property-name="reporterAccount"> |
| 6522 | <span class="json-property-name">reporterAccount:</span> | |
| 6523 | <span class="json-property-type"> | |
| 6524 | <span class=""> | |
| 6525 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
| 6526 | </span> | |
| 6527 | </span> | |
| 5e1c08eb C |
6528 | <span class="json-property-range" title="Value limits"></span> |
| 6529 | </dt> | |
| 5d00a3d7 C |
6530 | <dt data-property-name="video"> |
| 6531 | <span class="json-property-name">video:</span> | |
| 6532 | <span class="json-property-type">object</span> | |
| 5e1c08eb C |
6533 | <span class="json-property-range" title="Value limits"></span> |
| 6534 | </dt> | |
| ad9e39fb C |
6535 | <dt class="json-inner-schema"> |
| 6536 | <section class="json-schema-properties"> | |
| 6537 | <dl> | |
| 6538 | <dt data-property-name="id"> | |
| 6539 | <span class="json-property-name">id:</span> | |
| 6540 | <span class="json-property-type">number</span> | |
| 6541 | <span class="json-property-range" title="Value limits"></span> | |
| 6542 | </dt> | |
| 6543 | <dt data-property-name="name"> | |
| 6544 | <span class="json-property-name">name:</span> | |
| 6545 | <span class="json-property-type">string</span> | |
| 6546 | <span class="json-property-range" title="Value limits"></span> | |
| 6547 | </dt> | |
| 6548 | <dt data-property-name="uuid"> | |
| 6549 | <span class="json-property-name">uuid:</span> | |
| 6550 | <span class="json-property-type">string</span> | |
| 6551 | <span class="json-property-range" title="Value limits"></span> | |
| 6552 | </dt> | |
| 6553 | <dt data-property-name="url"> | |
| 6554 | <span class="json-property-name">url:</span> | |
| 6555 | <span class="json-property-type">string</span> | |
| 6556 | <span class="json-property-range" title="Value limits"></span> | |
| 6557 | </dt> | |
| 6558 | </dl> | |
| 6559 | </section> | |
| 6560 | </dt> | |
| 5e1c08eb C |
6561 | <dt data-property-name="createdAt"> |
| 6562 | <span class="json-property-name">createdAt:</span> | |
| 6563 | <span class="json-property-type">string</span> | |
| 6564 | <span class="json-property-range" title="Value limits"></span> | |
| 6565 | </dt> | |
| 6566 | </dl> | |
| 6567 | </section> | |
| 6568 | </div> | |
| 6569 | <div class="doc-examples"> | |
| 6570 | <section> | |
| 6571 | <h5>Example</h5> | |
| 6572 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 6573 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 6574 | <span class="hljs-attr">"reason"</span>: <span class="hljs-string">"string"</span>, | |
| 5d00a3d7 C |
6575 | <span class="hljs-attr">"reporterAccount"</span>: { |
| 6576 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 6577 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 6578 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 6579 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 6580 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 6581 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 6582 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 6583 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 6584 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6585 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6586 | <span class="hljs-attr">"avatar"</span>: { | |
| 6587 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 6588 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6589 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 6590 | } | |
| 6591 | }, | |
| 61b66b36 C |
6592 | <span class="hljs-attr">"video"</span>: { |
| 6593 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 6594 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 6595 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 6596 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span> | |
| 6597 | }, | |
| 5e1c08eb C |
6598 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span> |
| 6599 | } | |
| 6600 | </code></pre> | |
| 6601 | <!-- </div> --> | |
| 6602 | </section> | |
| 6603 | </div> | |
| 6604 | </div> | |
| 6605 | </div> | |
| 6606 | <div id="definition-VideoBlacklist" class="definition panel" data-traverse-target="definition-VideoBlacklist"> | |
| 6607 | <h2 class="panel-title"> | |
| 6608 | <a name="/definitions/VideoBlacklist"></a>VideoBlacklist: | |
| 6609 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 6610 | <span class="json-property-range" title="Value limits"></span> | |
| 6611 | ||
| 6612 | ||
| 6613 | </span> --> | |
| 6614 | </h2> | |
| 6615 | <div class="doc-row"> | |
| 6616 | <div class="doc-copy"> | |
| 6617 | <section class="json-schema-properties"> | |
| 6618 | <dl> | |
| 6619 | <dt data-property-name="id"> | |
| 6620 | <span class="json-property-name">id:</span> | |
| 6621 | <span class="json-property-type">number</span> | |
| 6622 | <span class="json-property-range" title="Value limits"></span> | |
| 6623 | </dt> | |
| 6624 | <dt data-property-name="videoId"> | |
| 6625 | <span class="json-property-name">videoId:</span> | |
| 6626 | <span class="json-property-type">number</span> | |
| 6627 | <span class="json-property-range" title="Value limits"></span> | |
| 6628 | </dt> | |
| 6629 | <dt data-property-name="createdAt"> | |
| 6630 | <span class="json-property-name">createdAt:</span> | |
| 6631 | <span class="json-property-type">string</span> | |
| 6632 | <span class="json-property-range" title="Value limits"></span> | |
| 6633 | </dt> | |
| 6634 | <dt data-property-name="updatedAt"> | |
| 6635 | <span class="json-property-name">updatedAt:</span> | |
| 6636 | <span class="json-property-type">string</span> | |
| 6637 | <span class="json-property-range" title="Value limits"></span> | |
| 6638 | </dt> | |
| 6639 | <dt data-property-name="name"> | |
| 6640 | <span class="json-property-name">name:</span> | |
| 6641 | <span class="json-property-type">string</span> | |
| 6642 | <span class="json-property-range" title="Value limits"></span> | |
| 6643 | </dt> | |
| 6644 | <dt data-property-name="uuid"> | |
| 6645 | <span class="json-property-name">uuid:</span> | |
| 6646 | <span class="json-property-type">string</span> | |
| 6647 | <span class="json-property-range" title="Value limits"></span> | |
| 6648 | </dt> | |
| 6649 | <dt data-property-name="description"> | |
| 6650 | <span class="json-property-name">description:</span> | |
| 6651 | <span class="json-property-type">string</span> | |
| 6652 | <span class="json-property-range" title="Value limits"></span> | |
| 6653 | </dt> | |
| 6654 | <dt data-property-name="duration"> | |
| 6655 | <span class="json-property-name">duration:</span> | |
| 6656 | <span class="json-property-type">number</span> | |
| 6657 | <span class="json-property-range" title="Value limits"></span> | |
| 6658 | </dt> | |
| 6659 | <dt data-property-name="views"> | |
| 6660 | <span class="json-property-name">views:</span> | |
| 6661 | <span class="json-property-type">number</span> | |
| 6662 | <span class="json-property-range" title="Value limits"></span> | |
| 6663 | </dt> | |
| 6664 | <dt data-property-name="likes"> | |
| 6665 | <span class="json-property-name">likes:</span> | |
| 6666 | <span class="json-property-type">number</span> | |
| 6667 | <span class="json-property-range" title="Value limits"></span> | |
| 6668 | </dt> | |
| 6669 | <dt data-property-name="dislikes"> | |
| 6670 | <span class="json-property-name">dislikes:</span> | |
| 6671 | <span class="json-property-type">number</span> | |
| 6672 | <span class="json-property-range" title="Value limits"></span> | |
| 6673 | </dt> | |
| 6674 | <dt data-property-name="nsfw"> | |
| 6675 | <span class="json-property-name">nsfw:</span> | |
| 6676 | <span class="json-property-type">boolean</span> | |
| 6677 | <span class="json-property-range" title="Value limits"></span> | |
| 6678 | </dt> | |
| 6679 | </dl> | |
| 6680 | </section> | |
| 6681 | </div> | |
| 6682 | <div class="doc-examples"> | |
| 6683 | <section> | |
| 6684 | <h5>Example</h5> | |
| 6685 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 6686 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 6687 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 6688 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6689 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6690 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 6691 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 6692 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 6693 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 6694 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 6695 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 6696 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 6697 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
| 6698 | } | |
| 6699 | </code></pre> | |
| 6700 | <!-- </div> --> | |
| 6701 | </section> | |
| 6702 | </div> | |
| 6703 | </div> | |
| 6704 | </div> | |
| 6705 | <div id="definition-VideoChannel" class="definition panel" data-traverse-target="definition-VideoChannel"> | |
| 6706 | <h2 class="panel-title"> | |
| 6707 | <a name="/definitions/VideoChannel"></a>VideoChannel: | |
| 6708 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 6709 | <span class="json-property-range" title="Value limits"></span> | |
| 6710 | ||
| 6711 | ||
| 6712 | </span> --> | |
| 6713 | </h2> | |
| 6714 | <div class="doc-row"> | |
| 6715 | <div class="doc-copy"> | |
| 6716 | <section class="json-schema-properties"> | |
| 6717 | <dl> | |
| 6718 | <dt data-property-name="displayName"> | |
| 6719 | <span class="json-property-name">displayName:</span> | |
| 6720 | <span class="json-property-type">string</span> | |
| 6721 | <span class="json-property-range" title="Value limits"></span> | |
| 6722 | </dt> | |
| 6723 | <dt data-property-name="description"> | |
| 6724 | <span class="json-property-name">description:</span> | |
| 6725 | <span class="json-property-type">string</span> | |
| 6726 | <span class="json-property-range" title="Value limits"></span> | |
| 6727 | </dt> | |
| 6728 | <dt data-property-name="isLocal"> | |
| 6729 | <span class="json-property-name">isLocal:</span> | |
| 6730 | <span class="json-property-type">boolean</span> | |
| 6731 | <span class="json-property-range" title="Value limits"></span> | |
| 6732 | </dt> | |
| cc918ac3 C |
6733 | <dt data-property-name="ownerAccount"> |
| 6734 | <span class="json-property-name">ownerAccount:</span> | |
| 5e1c08eb C |
6735 | <span class="json-property-type">object</span> |
| 6736 | <span class="json-property-range" title="Value limits"></span> | |
| 6737 | </dt> | |
| ad9e39fb C |
6738 | <dt class="json-inner-schema"> |
| 6739 | <section class="json-schema-properties"> | |
| 6740 | <dl> | |
| 6741 | <dt data-property-name="id"> | |
| 6742 | <span class="json-property-name">id:</span> | |
| 6743 | <span class="json-property-type">number</span> | |
| 6744 | <span class="json-property-range" title="Value limits"></span> | |
| 6745 | </dt> | |
| 6746 | <dt data-property-name="uuid"> | |
| 6747 | <span class="json-property-name">uuid:</span> | |
| 6748 | <span class="json-property-type">string</span> | |
| 6749 | <span class="json-property-range" title="Value limits"></span> | |
| 6750 | </dt> | |
| 6751 | </dl> | |
| 6752 | </section> | |
| 6753 | </dt> | |
| 5e1c08eb C |
6754 | </dl> |
| 6755 | </section> | |
| 6756 | </div> | |
| 6757 | <div class="doc-examples"> | |
| 6758 | <section> | |
| 6759 | <h5>Example</h5> | |
| 6760 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 6761 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 6762 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 6763 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| cc918ac3 C |
6764 | <span class="hljs-attr">"ownerAccount"</span>: { |
| 6765 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5e1c08eb | 6766 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> |
| cc918ac3 | 6767 | } |
| 5e1c08eb C |
6768 | } |
| 6769 | </code></pre> | |
| 6770 | <!-- </div> --> | |
| 6771 | </section> | |
| 6772 | </div> | |
| 6773 | </div> | |
| 6774 | </div> | |
| 6775 | <div id="definition-VideoComment" class="definition panel" data-traverse-target="definition-VideoComment"> | |
| 6776 | <h2 class="panel-title"> | |
| 6777 | <a name="/definitions/VideoComment"></a>VideoComment: | |
| 6778 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 6779 | <span class="json-property-range" title="Value limits"></span> | |
| 6780 | ||
| 6781 | ||
| 6782 | </span> --> | |
| 6783 | </h2> | |
| 6784 | <div class="doc-row"> | |
| 6785 | <div class="doc-copy"> | |
| 6786 | <section class="json-schema-properties"> | |
| 6787 | <dl> | |
| 6788 | <dt data-property-name="id"> | |
| 6789 | <span class="json-property-name">id:</span> | |
| 6790 | <span class="json-property-type">number</span> | |
| 6791 | <span class="json-property-range" title="Value limits"></span> | |
| 6792 | </dt> | |
| 6793 | <dt data-property-name="url"> | |
| 6794 | <span class="json-property-name">url:</span> | |
| 6795 | <span class="json-property-type">string</span> | |
| 6796 | <span class="json-property-range" title="Value limits"></span> | |
| 6797 | </dt> | |
| 6798 | <dt data-property-name="text"> | |
| 6799 | <span class="json-property-name">text:</span> | |
| 6800 | <span class="json-property-type">string</span> | |
| 6801 | <span class="json-property-range" title="Value limits"></span> | |
| 6802 | </dt> | |
| 6803 | <dt data-property-name="threadId"> | |
| 6804 | <span class="json-property-name">threadId:</span> | |
| 6805 | <span class="json-property-type">number</span> | |
| 6806 | <span class="json-property-range" title="Value limits"></span> | |
| 6807 | </dt> | |
| 6808 | <dt data-property-name="inReplyToCommentId"> | |
| 6809 | <span class="json-property-name">inReplyToCommentId:</span> | |
| 6810 | <span class="json-property-type">number</span> | |
| 6811 | <span class="json-property-range" title="Value limits"></span> | |
| 6812 | </dt> | |
| 6813 | <dt data-property-name="videoId"> | |
| 6814 | <span class="json-property-name">videoId:</span> | |
| 6815 | <span class="json-property-type">number</span> | |
| 6816 | <span class="json-property-range" title="Value limits"></span> | |
| 6817 | </dt> | |
| 6818 | <dt data-property-name="createdAt"> | |
| 6819 | <span class="json-property-name">createdAt:</span> | |
| 6820 | <span class="json-property-type">string</span> | |
| 6821 | <span class="json-property-range" title="Value limits"></span> | |
| 6822 | </dt> | |
| 6823 | <dt data-property-name="updatedAt"> | |
| 6824 | <span class="json-property-name">updatedAt:</span> | |
| 6825 | <span class="json-property-type">string</span> | |
| 6826 | <span class="json-property-range" title="Value limits"></span> | |
| 6827 | </dt> | |
| 6828 | <dt data-property-name="totalReplies"> | |
| 6829 | <span class="json-property-name">totalReplies:</span> | |
| 6830 | <span class="json-property-type">number</span> | |
| 6831 | <span class="json-property-range" title="Value limits"></span> | |
| 6832 | </dt> | |
| 6833 | <dt data-property-name="account"> | |
| 6834 | <span class="json-property-name">account:</span> | |
| 6835 | <span class="json-property-type"> | |
| 6836 | <span class=""> | |
| 6837 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
| 6838 | </span> | |
| 6839 | </span> | |
| 6840 | <span class="json-property-range" title="Value limits"></span> | |
| 6841 | </dt> | |
| 6842 | </dl> | |
| 6843 | </section> | |
| 6844 | </div> | |
| 6845 | <div class="doc-examples"> | |
| 6846 | <section> | |
| 6847 | <h5>Example</h5> | |
| 6848 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 6849 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 6850 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 6851 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 6852 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 6853 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 6854 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 6855 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6856 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6857 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 6858 | <span class="hljs-attr">"account"</span>: { | |
| 6859 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 6860 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 6861 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 6862 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 6863 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 6864 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 6865 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 6866 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 6867 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6868 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6869 | <span class="hljs-attr">"avatar"</span>: { | |
| 6870 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 6871 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6872 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 6873 | } | |
| 6874 | } | |
| 6875 | } | |
| 6876 | </code></pre> | |
| 6877 | <!-- </div> --> | |
| 6878 | </section> | |
| 6879 | </div> | |
| 6880 | </div> | |
| 6881 | </div> | |
| 6882 | <div id="definition-VideoCommentThreadTree" class="definition panel" data-traverse-target="definition-VideoCommentThreadTree"> | |
| 6883 | <h2 class="panel-title"> | |
| 6884 | <a name="/definitions/VideoCommentThreadTree"></a>VideoCommentThreadTree: | |
| 6885 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 6886 | <span class="json-property-range" title="Value limits"></span> | |
| 6887 | ||
| 6888 | ||
| 6889 | </span> --> | |
| 6890 | </h2> | |
| 6891 | <div class="doc-row"> | |
| 6892 | <div class="doc-copy"> | |
| 6893 | <section class="json-schema-properties"> | |
| 6894 | <dl> | |
| 6895 | <dt data-property-name="comment"> | |
| 6896 | <span class="json-property-name">comment:</span> | |
| 6897 | <span class="json-property-type"> | |
| 6898 | <span class=""> | |
| 6899 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | |
| 6900 | </span> | |
| 6901 | </span> | |
| 6902 | <span class="json-property-range" title="Value limits"></span> | |
| 6903 | </dt> | |
| 6904 | <dt data-property-name="children"> | |
| 6905 | <span class="json-property-name">children:</span> | |
| 6906 | <span class="json-property-type"> | |
| 6907 | <span class="json-schema-ref-array"> | |
| 6908 | <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a> | |
| 6909 | </span> | |
| 6910 | </span> | |
| 6911 | <span class="json-property-range" title="Value limits"></span> | |
| 6912 | </dt> | |
| ad9e39fb C |
6913 | <dt class="json-inner-schema"> |
| 6914 | <section class="json-schema-array-items"> | |
| 6915 | <span class="json-property-type"> | |
| 6916 | <span class=""> | |
| 6917 | <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a> | |
| 6918 | </span> | |
| 6919 | </span> | |
| 6920 | <span class="json-property-range" title="Value limits"></span> | |
| 6921 | <div class="json-inner-schema"> </div> | |
| 6922 | </section> | |
| 6923 | </dt> | |
| 5e1c08eb C |
6924 | </dl> |
| 6925 | </section> | |
| 6926 | </div> | |
| 6927 | <div class="doc-examples"> | |
| 6928 | <section> | |
| 6929 | <h5>Example</h5> | |
| 6930 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 6931 | <span class="hljs-attr">"comment"</span>: { | |
| 6932 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 6933 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 6934 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 6935 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 6936 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 6937 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 6938 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6939 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6940 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 6941 | <span class="hljs-attr">"account"</span>: { | |
| 6942 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 6943 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 6944 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 6945 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 6946 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 6947 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 6948 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 6949 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 6950 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6951 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6952 | <span class="hljs-attr">"avatar"</span>: { | |
| 6953 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 6954 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6955 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 6956 | } | |
| 6957 | } | |
| 6958 | }, | |
| 6959 | <span class="hljs-attr">"children"</span>: [ | |
| 6960 | { | |
| 6961 | <span class="hljs-attr">"comment"</span>: { | |
| 6962 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 6963 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 6964 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 6965 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 6966 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 6967 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 6968 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6969 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6970 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 6971 | <span class="hljs-attr">"account"</span>: { | |
| 6972 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 6973 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 6974 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 6975 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 6976 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 6977 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 6978 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 6979 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 6980 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6981 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6982 | <span class="hljs-attr">"avatar"</span>: { | |
| 6983 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 6984 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6985 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 6986 | } | |
| 6987 | } | |
| 6988 | }, | |
| 6989 | <span class="hljs-attr">"children"</span>: [ | |
| 6990 | { | |
| 6991 | <span class="hljs-attr">"comment"</span>: { | |
| 6992 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 6993 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 6994 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 6995 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 6996 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 6997 | <span class="hljs-attr">"videoId"</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">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 7001 | <span class="hljs-attr">"account"</span>: { | |
| 7002 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 7003 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7004 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 7005 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7006 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 7007 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 7008 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7009 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7010 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7011 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7012 | <span class="hljs-attr">"avatar"</span>: { | |
| 7013 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 7014 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7015 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7016 | } | |
| 7017 | } | |
| 7018 | } | |
| 7019 | } | |
| 7020 | ] | |
| 7021 | } | |
| 7022 | ] | |
| 7023 | } | |
| 7024 | </code></pre> | |
| 7025 | <!-- </div> --> | |
| 7026 | </section> | |
| 7027 | </div> | |
| 7028 | </div> | |
| 7029 | </div> | |
| 7030 | <div id="definition-Avatar" class="definition panel" data-traverse-target="definition-Avatar"> | |
| 7031 | <h2 class="panel-title"> | |
| 7032 | <a name="/definitions/Avatar"></a>Avatar: | |
| 7033 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 7034 | <span class="json-property-range" title="Value limits"></span> | |
| 7035 | ||
| 7036 | ||
| 7037 | </span> --> | |
| 7038 | </h2> | |
| 7039 | <div class="doc-row"> | |
| 7040 | <div class="doc-copy"> | |
| 7041 | <section class="json-schema-properties"> | |
| 7042 | <dl> | |
| 7043 | <dt data-property-name="path"> | |
| 7044 | <span class="json-property-name">path:</span> | |
| 7045 | <span class="json-property-type">string</span> | |
| 7046 | <span class="json-property-range" title="Value limits"></span> | |
| 7047 | </dt> | |
| 7048 | <dt data-property-name="createdAt"> | |
| 7049 | <span class="json-property-name">createdAt:</span> | |
| 7050 | <span class="json-property-type">string</span> | |
| 7051 | <span class="json-property-range" title="Value limits"></span> | |
| 7052 | </dt> | |
| 7053 | <dt data-property-name="updatedAt"> | |
| 7054 | <span class="json-property-name">updatedAt:</span> | |
| 7055 | <span class="json-property-type">string</span> | |
| 7056 | <span class="json-property-range" title="Value limits"></span> | |
| 7057 | </dt> | |
| 7058 | </dl> | |
| 7059 | </section> | |
| 7060 | </div> | |
| 7061 | <div class="doc-examples"> | |
| 7062 | <section> | |
| 7063 | <h5>Example</h5> | |
| 7064 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7065 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 7066 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7067 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7068 | } | |
| 7069 | </code></pre> | |
| 7070 | <!-- </div> --> | |
| 7071 | </section> | |
| 7072 | </div> | |
| 7073 | </div> | |
| 7074 | </div> | |
| 7075 | <div id="definition-Actor" class="definition panel" data-traverse-target="definition-Actor"> | |
| 7076 | <h2 class="panel-title"> | |
| 7077 | <a name="/definitions/Actor"></a>Actor: | |
| 7078 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 7079 | <span class="json-property-range" title="Value limits"></span> | |
| 7080 | ||
| 7081 | ||
| 7082 | </span> --> | |
| 7083 | </h2> | |
| 7084 | <div class="doc-row"> | |
| 7085 | <div class="doc-copy"> | |
| 7086 | <section class="json-schema-properties"> | |
| 7087 | <dl> | |
| 7088 | <dt data-property-name="id"> | |
| 7089 | <span class="json-property-name">id:</span> | |
| 7090 | <span class="json-property-type">number</span> | |
| 7091 | <span class="json-property-range" title="Value limits"></span> | |
| 7092 | </dt> | |
| 7093 | <dt data-property-name="uuid"> | |
| 7094 | <span class="json-property-name">uuid:</span> | |
| 7095 | <span class="json-property-type">string</span> | |
| 7096 | <span class="json-property-range" title="Value limits"></span> | |
| 7097 | </dt> | |
| 7098 | <dt data-property-name="url"> | |
| 7099 | <span class="json-property-name">url:</span> | |
| 7100 | <span class="json-property-type">string</span> | |
| 7101 | <span class="json-property-range" title="Value limits"></span> | |
| 7102 | </dt> | |
| 7103 | <dt data-property-name="name"> | |
| 7104 | <span class="json-property-name">name:</span> | |
| 7105 | <span class="json-property-type">string</span> | |
| 7106 | <span class="json-property-range" title="Value limits"></span> | |
| 7107 | </dt> | |
| 7108 | <dt data-property-name="host"> | |
| 7109 | <span class="json-property-name">host:</span> | |
| 7110 | <span class="json-property-type">string</span> | |
| 7111 | <span class="json-property-range" title="Value limits"></span> | |
| 7112 | </dt> | |
| 7113 | <dt data-property-name="followingCount"> | |
| 7114 | <span class="json-property-name">followingCount:</span> | |
| 7115 | <span class="json-property-type">number</span> | |
| 7116 | <span class="json-property-range" title="Value limits"></span> | |
| 7117 | </dt> | |
| 7118 | <dt data-property-name="followersCount"> | |
| 7119 | <span class="json-property-name">followersCount:</span> | |
| 7120 | <span class="json-property-type">number</span> | |
| 7121 | <span class="json-property-range" title="Value limits"></span> | |
| 7122 | </dt> | |
| 7123 | <dt data-property-name="createdAt"> | |
| 7124 | <span class="json-property-name">createdAt:</span> | |
| 7125 | <span class="json-property-type">string</span> | |
| 7126 | <span class="json-property-range" title="Value limits"></span> | |
| 7127 | </dt> | |
| 7128 | <dt data-property-name="updatedAt"> | |
| 7129 | <span class="json-property-name">updatedAt:</span> | |
| 7130 | <span class="json-property-type">string</span> | |
| 7131 | <span class="json-property-range" title="Value limits"></span> | |
| 7132 | </dt> | |
| 7133 | <dt data-property-name="avatar"> | |
| 7134 | <span class="json-property-name">avatar:</span> | |
| 7135 | <span class="json-property-type"> | |
| 7136 | <span class=""> | |
| 7137 | <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a> | |
| 7138 | </span> | |
| 7139 | </span> | |
| 7140 | <span class="json-property-range" title="Value limits"></span> | |
| 7141 | </dt> | |
| 7142 | </dl> | |
| 7143 | </section> | |
| 7144 | </div> | |
| 7145 | <div class="doc-examples"> | |
| 7146 | <section> | |
| 7147 | <h5>Example</h5> | |
| 7148 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7149 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7150 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 7151 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7152 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 7153 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 7154 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7155 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7156 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7157 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7158 | <span class="hljs-attr">"avatar"</span>: { | |
| 7159 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 7160 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7161 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7162 | } | |
| 7163 | } | |
| 7164 | </code></pre> | |
| 7165 | <!-- </div> --> | |
| 7166 | </section> | |
| 7167 | </div> | |
| 7168 | </div> | |
| 7169 | </div> | |
| 7170 | <div id="definition-Account" class="definition panel" data-traverse-target="definition-Account"> | |
| 7171 | <h2 class="panel-title"> | |
| 7172 | <a name="/definitions/Account"></a>Account: | |
| 7173 | <!-- <span class="json-property-type"><span class="json-property-type"></span> | |
| 7174 | <span class="json-property-range" title="Value limits"></span> | |
| 7175 | ||
| 7176 | ||
| 7177 | </span> --> | |
| 7178 | </h2> | |
| 7179 | <div class="doc-row"> | |
| 7180 | <div class="doc-copy"> | |
| 7181 | <section class="json-schema-allOf"> | |
| 7182 | <section class="json-schema-allOf-inherited"> | |
| 7183 | <ul> | |
| 7184 | <span class=""> | |
| 7185 | <a class="json-schema-ref" href="#/definitions/Actor">Actor</a> | |
| 7186 | </span> | |
| 7187 | </ul> | |
| 7188 | </section> | |
| 7189 | <section class="json-schema-allOf-additional"> | |
| 7190 | <section class="json-schema-properties"> | |
| 7191 | <dl> | |
| 7192 | <dt data-property-name="displayName"> | |
| 7193 | <span class="json-property-name">displayName:</span> | |
| 7194 | <span class="json-property-type">string</span> | |
| 7195 | <span class="json-property-range" title="Value limits"></span> | |
| 7196 | </dt> | |
| 7197 | </dl> | |
| 7198 | </section> | |
| 7199 | </section> | |
| 7200 | </section> | |
| 7201 | </div> | |
| 7202 | <div class="doc-examples"> | |
| 7203 | <section> | |
| 7204 | <h5>Example</h5> | |
| 7205 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7206 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 7207 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7208 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 7209 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7210 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 7211 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 7212 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7213 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7214 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7215 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7216 | <span class="hljs-attr">"avatar"</span>: { | |
| 7217 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 7218 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7219 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7220 | } | |
| 7221 | } | |
| 7222 | </code></pre> | |
| 7223 | <!-- </div> --> | |
| 7224 | </section> | |
| 7225 | </div> | |
| 7226 | </div> | |
| 7227 | </div> | |
| 7228 | <div id="definition-User" class="definition panel" data-traverse-target="definition-User"> | |
| 7229 | <h2 class="panel-title"> | |
| 7230 | <a name="/definitions/User"></a>User: | |
| 7231 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 7232 | <span class="json-property-range" title="Value limits"></span> | |
| 7233 | ||
| 7234 | ||
| 7235 | </span> --> | |
| 7236 | </h2> | |
| 7237 | <div class="doc-row"> | |
| 7238 | <div class="doc-copy"> | |
| 7239 | <section class="json-schema-properties"> | |
| 7240 | <dl> | |
| 7241 | <dt data-property-name="id"> | |
| 7242 | <span class="json-property-name">id:</span> | |
| 7243 | <span class="json-property-type">number</span> | |
| 7244 | <span class="json-property-range" title="Value limits"></span> | |
| 7245 | </dt> | |
| 7246 | <dt data-property-name="username"> | |
| 7247 | <span class="json-property-name">username:</span> | |
| 7248 | <span class="json-property-type">string</span> | |
| 7249 | <span class="json-property-range" title="Value limits"></span> | |
| 7250 | </dt> | |
| 7251 | <dt data-property-name="email"> | |
| 7252 | <span class="json-property-name">email:</span> | |
| 7253 | <span class="json-property-type">string</span> | |
| 7254 | <span class="json-property-range" title="Value limits"></span> | |
| 7255 | </dt> | |
| 7256 | <dt data-property-name="displayNSFW"> | |
| 7257 | <span class="json-property-name">displayNSFW:</span> | |
| 7258 | <span class="json-property-type">boolean</span> | |
| 7259 | <span class="json-property-range" title="Value limits"></span> | |
| 7260 | </dt> | |
| 7261 | <dt data-property-name="autoPlayVideo"> | |
| 7262 | <span class="json-property-name">autoPlayVideo:</span> | |
| 7263 | <span class="json-property-type">boolean</span> | |
| 7264 | <span class="json-property-range" title="Value limits"></span> | |
| 7265 | </dt> | |
| 7266 | <dt data-property-name="role"> | |
| 7267 | <span class="json-property-name">role:</span> | |
| 7268 | <span class="json-property-type">string</span> | |
| 7269 | <span class="json-property-enum" title="Possible values"> | |
| 7270 | <span class="json-property-enum-item">User</span>, | |
| 7271 | <span class="json-property-enum-item">Moderator</span>, | |
| 7272 | <span class="json-property-enum-item">Administrator</span> | |
| 7273 | </span> | |
| 7274 | <span class="json-property-range" title="Value limits"></span> | |
| 7275 | </dt> | |
| 7276 | <dt data-property-name="videoQuota"> | |
| 7277 | <span class="json-property-name">videoQuota:</span> | |
| 7278 | <span class="json-property-type">number</span> | |
| 7279 | <span class="json-property-range" title="Value limits"></span> | |
| 7280 | </dt> | |
| 7281 | <dt data-property-name="createdAt"> | |
| 7282 | <span class="json-property-name">createdAt:</span> | |
| 7283 | <span class="json-property-type">string</span> | |
| 7284 | <span class="json-property-range" title="Value limits"></span> | |
| 7285 | </dt> | |
| 7286 | <dt data-property-name="account"> | |
| 7287 | <span class="json-property-name">account:</span> | |
| 7288 | <span class="json-property-type"> | |
| 7289 | <span class=""> | |
| 7290 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
| 7291 | </span> | |
| 7292 | </span> | |
| 7293 | <span class="json-property-range" title="Value limits"></span> | |
| 7294 | </dt> | |
| 7295 | <dt data-property-name="videoChannels"> | |
| 7296 | <span class="json-property-name">videoChannels:</span> | |
| 7297 | <span class="json-property-type"> | |
| 7298 | <span class="json-schema-ref-array"> | |
| 7299 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
| 7300 | </span> | |
| 7301 | </span> | |
| 7302 | <span class="json-property-range" title="Value limits"></span> | |
| 7303 | </dt> | |
| ad9e39fb C |
7304 | <dt class="json-inner-schema"> |
| 7305 | <section class="json-schema-array-items"> | |
| 7306 | <span class="json-property-type"> | |
| 7307 | <span class=""> | |
| 7308 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
| 7309 | </span> | |
| 7310 | </span> | |
| 7311 | <span class="json-property-range" title="Value limits"></span> | |
| 7312 | <div class="json-inner-schema"> </div> | |
| 7313 | </section> | |
| 7314 | </dt> | |
| 5e1c08eb C |
7315 | </dl> |
| 7316 | </section> | |
| 7317 | </div> | |
| 7318 | <div class="doc-examples"> | |
| 7319 | <section> | |
| 7320 | <h5>Example</h5> | |
| 7321 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7322 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7323 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
| 7324 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 7325 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
| 7326 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
| 7327 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
| 7328 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
| 7329 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7330 | <span class="hljs-attr">"account"</span>: { | |
| 7331 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 7332 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7333 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 7334 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7335 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 7336 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 7337 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7338 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7339 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7340 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7341 | <span class="hljs-attr">"avatar"</span>: { | |
| 7342 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 7343 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7344 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7345 | } | |
| 7346 | }, | |
| 7347 | <span class="hljs-attr">"videoChannels"</span>: [ | |
| 7348 | { | |
| 7349 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 7350 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 7351 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| cc918ac3 C |
7352 | <span class="hljs-attr">"ownerAccount"</span>: { |
| 7353 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5e1c08eb | 7354 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> |
| cc918ac3 | 7355 | } |
| 5e1c08eb C |
7356 | } |
| 7357 | ] | |
| 7358 | } | |
| 7359 | </code></pre> | |
| 7360 | <!-- </div> --> | |
| 7361 | </section> | |
| 7362 | </div> | |
| 7363 | </div> | |
| 7364 | </div> | |
| 7365 | <div id="definition-ServerConfig" class="definition panel" data-traverse-target="definition-ServerConfig"> | |
| 7366 | <h2 class="panel-title"> | |
| 7367 | <a name="/definitions/ServerConfig"></a>ServerConfig: | |
| 7368 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 7369 | <span class="json-property-range" title="Value limits"></span> | |
| 7370 | ||
| 7371 | ||
| 7372 | </span> --> | |
| 7373 | </h2> | |
| 7374 | <div class="doc-row"> | |
| 7375 | <div class="doc-copy"> | |
| 7376 | <section class="json-schema-properties"> | |
| 7377 | <dl> | |
| 7378 | <dt data-property-name="signup"> | |
| 7379 | <span class="json-property-name">signup:</span> | |
| 7380 | <span class="json-property-type">object</span> | |
| 7381 | <span class="json-property-range" title="Value limits"></span> | |
| 7382 | </dt> | |
| ad9e39fb C |
7383 | <dt class="json-inner-schema"> |
| 7384 | <section class="json-schema-properties"> | |
| 7385 | <dl> | |
| 7386 | <dt data-property-name="allowed"> | |
| 7387 | <span class="json-property-name">allowed:</span> | |
| 7388 | <span class="json-property-type">boolean</span> | |
| 7389 | <span class="json-property-range" title="Value limits"></span> | |
| 7390 | </dt> | |
| 7391 | </dl> | |
| 7392 | </section> | |
| 7393 | </dt> | |
| 5e1c08eb C |
7394 | <dt data-property-name="transcoding"> |
| 7395 | <span class="json-property-name">transcoding:</span> | |
| 7396 | <span class="json-property-type">object</span> | |
| 7397 | <span class="json-property-range" title="Value limits"></span> | |
| 7398 | </dt> | |
| ad9e39fb C |
7399 | <dt class="json-inner-schema"> |
| 7400 | <section class="json-schema-properties"> | |
| 7401 | <dl> | |
| 7402 | <dt data-property-name="enabledResolutions"> | |
| 7403 | <span class="json-property-name">enabledResolutions:</span> | |
| 7404 | <span class="json-property-type">number[]</span> | |
| 7405 | <span class="json-property-range" title="Value limits"></span> | |
| 7406 | </dt> | |
| 7407 | <dt class="json-inner-schema"> | |
| 7408 | <section class="json-schema-array-items"> | |
| 7409 | <span class="json-property-type">number</span> | |
| 7410 | <span class="json-property-range" title="Value limits"></span> | |
| 7411 | <div class="json-inner-schema"> </div> | |
| 7412 | </section> | |
| 7413 | </dt> | |
| 7414 | </dl> | |
| 7415 | </section> | |
| 7416 | </dt> | |
| 5e1c08eb C |
7417 | <dt data-property-name="avatar"> |
| 7418 | <span class="json-property-name">avatar:</span> | |
| 7419 | <span class="json-property-type">object</span> | |
| 7420 | <span class="json-property-range" title="Value limits"></span> | |
| 7421 | </dt> | |
| ad9e39fb C |
7422 | <dt class="json-inner-schema"> |
| 7423 | <section class="json-schema-properties"> | |
| 7424 | <dl> | |
| 7425 | <dt data-property-name="file"> | |
| 7426 | <span class="json-property-name">file:</span> | |
| 7427 | <span class="json-property-type">object</span> | |
| 7428 | <span class="json-property-range" title="Value limits"></span> | |
| 7429 | </dt> | |
| 7430 | <dt class="json-inner-schema"> | |
| 7431 | <section class="json-schema-properties"> | |
| 7432 | <dl> | |
| 7433 | <dt data-property-name="size"> | |
| 7434 | <span class="json-property-name">size:</span> | |
| 7435 | <span class="json-property-type">object</span> | |
| 7436 | <span class="json-property-range" title="Value limits"></span> | |
| 7437 | </dt> | |
| 7438 | <dt class="json-inner-schema"> | |
| 7439 | <section class="json-schema-properties"> | |
| 7440 | <dl> | |
| 7441 | <dt data-property-name="max"> | |
| 7442 | <span class="json-property-name">max:</span> | |
| 7443 | <span class="json-property-type">number</span> | |
| 7444 | <span class="json-property-range" title="Value limits"></span> | |
| 7445 | </dt> | |
| 7446 | </dl> | |
| 7447 | </section> | |
| 7448 | </dt> | |
| 7449 | </dl> | |
| 7450 | </section> | |
| 7451 | </dt> | |
| 7452 | <dt data-property-name="extensions"> | |
| 7453 | <span class="json-property-name">extensions:</span> | |
| 7454 | <span class="json-property-type">string[]</span> | |
| 7455 | <span class="json-property-range" title="Value limits"></span> | |
| 7456 | </dt> | |
| 7457 | <dt class="json-inner-schema"> | |
| 7458 | <section class="json-schema-array-items"> | |
| 7459 | <span class="json-property-type">string</span> | |
| 7460 | <span class="json-property-range" title="Value limits"></span> | |
| 7461 | <div class="json-inner-schema"> </div> | |
| 7462 | </section> | |
| 7463 | </dt> | |
| 7464 | </dl> | |
| 7465 | </section> | |
| 7466 | </dt> | |
| 5e1c08eb C |
7467 | <dt data-property-name="video"> |
| 7468 | <span class="json-property-name">video:</span> | |
| 7469 | <span class="json-property-type">object</span> | |
| 7470 | <span class="json-property-range" title="Value limits"></span> | |
| 7471 | </dt> | |
| ad9e39fb C |
7472 | <dt class="json-inner-schema"> |
| 7473 | <section class="json-schema-properties"> | |
| 7474 | <dl> | |
| 7475 | <dt data-property-name="file"> | |
| 7476 | <span class="json-property-name">file:</span> | |
| 7477 | <span class="json-property-type">object</span> | |
| 7478 | <span class="json-property-range" title="Value limits"></span> | |
| 7479 | </dt> | |
| 7480 | <dt class="json-inner-schema"> | |
| 7481 | <section class="json-schema-properties"> | |
| 7482 | <dl> | |
| 7483 | <dt data-property-name="extensions"> | |
| 7484 | <span class="json-property-name">extensions:</span> | |
| 7485 | <span class="json-property-type">string[]</span> | |
| 7486 | <span class="json-property-range" title="Value limits"></span> | |
| 7487 | </dt> | |
| 7488 | <dt class="json-inner-schema"> | |
| 7489 | <section class="json-schema-array-items"> | |
| 7490 | <span class="json-property-type">string</span> | |
| 7491 | <span class="json-property-range" title="Value limits"></span> | |
| 7492 | <div class="json-inner-schema"> </div> | |
| 7493 | </section> | |
| 7494 | </dt> | |
| 7495 | </dl> | |
| 7496 | </section> | |
| 7497 | </dt> | |
| 7498 | </dl> | |
| 7499 | </section> | |
| 7500 | </dt> | |
| 5e1c08eb C |
7501 | </dl> |
| 7502 | </section> | |
| 7503 | </div> | |
| 7504 | <div class="doc-examples"> | |
| 7505 | <section> | |
| 7506 | <h5>Example</h5> | |
| 7507 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7508 | <span class="hljs-attr">"signup"</span>: { | |
| 7509 | <span class="hljs-attr">"allowed"</span>: <span class="hljs-string">"boolean"</span> | |
| 7510 | }, | |
| 7511 | <span class="hljs-attr">"transcoding"</span>: { | |
| 7512 | <span class="hljs-attr">"enabledResolutions"</span>: [ | |
| 7513 | <span class="hljs-string">"number"</span> | |
| 7514 | ] | |
| 7515 | }, | |
| 7516 | <span class="hljs-attr">"avatar"</span>: { | |
| 7517 | <span class="hljs-attr">"file"</span>: { | |
| 7518 | <span class="hljs-attr">"size"</span>: { | |
| 7519 | <span class="hljs-attr">"max"</span>: <span class="hljs-string">"number"</span> | |
| 7520 | } | |
| 7521 | }, | |
| 7522 | <span class="hljs-attr">"extensions"</span>: [ | |
| 7523 | <span class="hljs-string">"string"</span> | |
| 7524 | ] | |
| 7525 | }, | |
| 7526 | <span class="hljs-attr">"video"</span>: { | |
| 7527 | <span class="hljs-attr">"file"</span>: { | |
| 7528 | <span class="hljs-attr">"extensions"</span>: [ | |
| 7529 | <span class="hljs-string">"string"</span> | |
| 7530 | ] | |
| 7531 | } | |
| 7532 | } | |
| 7533 | } | |
| 7534 | </code></pre> | |
| 7535 | <!-- </div> --> | |
| 7536 | </section> | |
| 7537 | </div> | |
| 7538 | </div> | |
| 7539 | </div> | |
| 7540 | <div id="definition-Follow" class="definition panel" data-traverse-target="definition-Follow"> | |
| 7541 | <h2 class="panel-title"> | |
| 7542 | <a name="/definitions/Follow"></a>Follow: | |
| 7543 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 7544 | <span class="json-property-range" title="Value limits"></span> | |
| 7545 | ||
| 7546 | ||
| 7547 | </span> --> | |
| 7548 | </h2> | |
| 7549 | <div class="doc-row"> | |
| 7550 | <div class="doc-copy"> | |
| 7551 | <section class="json-schema-properties"> | |
| 7552 | <dl> | |
| 7553 | <dt data-property-name="id"> | |
| 7554 | <span class="json-property-name">id:</span> | |
| 7555 | <span class="json-property-type">number</span> | |
| 7556 | <span class="json-property-range" title="Value limits"></span> | |
| 7557 | </dt> | |
| 7558 | <dt data-property-name="follower"> | |
| 7559 | <span class="json-property-name">follower:</span> | |
| 7560 | <span class="json-property-type"> | |
| 7561 | <span class=""> | |
| 7562 | <a class="json-schema-ref" href="#/definitions/Actor">Actor</a> | |
| 7563 | </span> | |
| 7564 | </span> | |
| 7565 | <span class="json-property-range" title="Value limits"></span> | |
| 7566 | </dt> | |
| 7567 | <dt data-property-name="following"> | |
| 7568 | <span class="json-property-name">following:</span> | |
| 7569 | <span class="json-property-type"> | |
| 7570 | <span class=""> | |
| 7571 | <a class="json-schema-ref" href="#/definitions/Actor">Actor</a> | |
| 7572 | </span> | |
| 7573 | </span> | |
| 7574 | <span class="json-property-range" title="Value limits"></span> | |
| 7575 | </dt> | |
| 7576 | <dt data-property-name="score"> | |
| 7577 | <span class="json-property-name">score:</span> | |
| 7578 | <span class="json-property-type">number</span> | |
| 7579 | <span class="json-property-range" title="Value limits"></span> | |
| 7580 | </dt> | |
| 7581 | <dt data-property-name="state"> | |
| 7582 | <span class="json-property-name">state:</span> | |
| 7583 | <span class="json-property-type">string</span> | |
| 7584 | <span class="json-property-enum" title="Possible values"> | |
| 7585 | <span class="json-property-enum-item">pending</span>, | |
| 7586 | <span class="json-property-enum-item">accepted</span> | |
| 7587 | </span> | |
| 7588 | <span class="json-property-range" title="Value limits"></span> | |
| 7589 | </dt> | |
| 7590 | <dt data-property-name="createdAt"> | |
| 7591 | <span class="json-property-name">createdAt:</span> | |
| 7592 | <span class="json-property-type">string</span> | |
| 7593 | <span class="json-property-range" title="Value limits"></span> | |
| 7594 | </dt> | |
| 7595 | <dt data-property-name="updatedAt"> | |
| 7596 | <span class="json-property-name">updatedAt:</span> | |
| 7597 | <span class="json-property-type">string</span> | |
| 7598 | <span class="json-property-range" title="Value limits"></span> | |
| 7599 | </dt> | |
| 7600 | </dl> | |
| 7601 | </section> | |
| 7602 | </div> | |
| 7603 | <div class="doc-examples"> | |
| 7604 | <section> | |
| 7605 | <h5>Example</h5> | |
| 7606 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7607 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7608 | <span class="hljs-attr">"follower"</span>: { | |
| 7609 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7610 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 7611 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7612 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 7613 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 7614 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7615 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7616 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7617 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7618 | <span class="hljs-attr">"avatar"</span>: { | |
| 7619 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 7620 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7621 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7622 | } | |
| 7623 | }, | |
| 7624 | <span class="hljs-attr">"following"</span>: { | |
| 7625 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7626 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 7627 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7628 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 7629 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 7630 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7631 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7632 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7633 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7634 | <span class="hljs-attr">"avatar"</span>: { | |
| 7635 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 7636 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7637 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7638 | } | |
| 7639 | }, | |
| 7640 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
| 7641 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
| 7642 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7643 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7644 | } | |
| 7645 | </code></pre> | |
| 7646 | <!-- </div> --> | |
| 7647 | </section> | |
| 7648 | </div> | |
| 7649 | </div> | |
| 7650 | </div> | |
| 7651 | <div id="definition-Job" class="definition panel" data-traverse-target="definition-Job"> | |
| 7652 | <h2 class="panel-title"> | |
| 7653 | <a name="/definitions/Job"></a>Job: | |
| 7654 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 7655 | <span class="json-property-range" title="Value limits"></span> | |
| 7656 | ||
| 7657 | ||
| 7658 | </span> --> | |
| 7659 | </h2> | |
| 7660 | <div class="doc-row"> | |
| 7661 | <div class="doc-copy"> | |
| 7662 | <section class="json-schema-properties"> | |
| 7663 | <dl> | |
| 7664 | <dt data-property-name="id"> | |
| 7665 | <span class="json-property-name">id:</span> | |
| 7666 | <span class="json-property-type">number</span> | |
| 7667 | <span class="json-property-range" title="Value limits"></span> | |
| 7668 | </dt> | |
| 7669 | <dt data-property-name="state"> | |
| 7670 | <span class="json-property-name">state:</span> | |
| 7671 | <span class="json-property-type">string</span> | |
| 7672 | <span class="json-property-enum" title="Possible values"> | |
| 7673 | <span class="json-property-enum-item">pending</span>, | |
| 7674 | <span class="json-property-enum-item">processing</span>, | |
| 7675 | <span class="json-property-enum-item">error</span>, | |
| 7676 | <span class="json-property-enum-item">success</span> | |
| 7677 | </span> | |
| 7678 | <span class="json-property-range" title="Value limits"></span> | |
| 7679 | </dt> | |
| 7680 | <dt data-property-name="category"> | |
| 7681 | <span class="json-property-name">category:</span> | |
| 7682 | <span class="json-property-type">string</span> | |
| 7683 | <span class="json-property-enum" title="Possible values"> | |
| 7684 | <span class="json-property-enum-item">transcoding</span>, | |
| 7685 | <span class="json-property-enum-item">activitypub-http</span> | |
| 7686 | </span> | |
| 7687 | <span class="json-property-range" title="Value limits"></span> | |
| 7688 | </dt> | |
| 7689 | <dt data-property-name="handlerName"> | |
| 7690 | <span class="json-property-name">handlerName:</span> | |
| 7691 | <span class="json-property-type">string</span> | |
| 7692 | <span class="json-property-range" title="Value limits"></span> | |
| 7693 | </dt> | |
| 7694 | <dt data-property-name="handlerInputData"> | |
| 7695 | <span class="json-property-name">handlerInputData:</span> | |
| 7696 | <span class="json-property-type">string</span> | |
| 7697 | <span class="json-property-range" title="Value limits"></span> | |
| 7698 | </dt> | |
| 7699 | <dt data-property-name="createdAt"> | |
| 7700 | <span class="json-property-name">createdAt:</span> | |
| 7701 | <span class="json-property-type">string</span> | |
| 7702 | <span class="json-property-range" title="Value limits"></span> | |
| 7703 | </dt> | |
| 7704 | <dt data-property-name="updatedAt"> | |
| 7705 | <span class="json-property-name">updatedAt:</span> | |
| 7706 | <span class="json-property-type">string</span> | |
| 7707 | <span class="json-property-range" title="Value limits"></span> | |
| 7708 | </dt> | |
| 7709 | </dl> | |
| 7710 | </section> | |
| 7711 | </div> | |
| 7712 | <div class="doc-examples"> | |
| 7713 | <section> | |
| 7714 | <h5>Example</h5> | |
| 7715 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7716 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7717 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
| 7718 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"string"</span>, | |
| 7719 | <span class="hljs-attr">"handlerName"</span>: <span class="hljs-string">"string"</span>, | |
| 7720 | <span class="hljs-attr">"handlerInputData"</span>: <span class="hljs-string">"string"</span>, | |
| 7721 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7722 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7723 | } | |
| 7724 | </code></pre> | |
| 7725 | <!-- </div> --> | |
| 7726 | </section> | |
| 7727 | </div> | |
| 7728 | </div> | |
| 7729 | </div> | |
| 7730 | <div id="definition-AddUserResponse" class="definition panel" data-traverse-target="definition-AddUserResponse"> | |
| 7731 | <h2 class="panel-title"> | |
| 7732 | <a name="/definitions/AddUserResponse"></a>AddUserResponse: | |
| 7733 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 7734 | <span class="json-property-range" title="Value limits"></span> | |
| 7735 | ||
| 7736 | ||
| 7737 | </span> --> | |
| 7738 | </h2> | |
| 7739 | <div class="doc-row"> | |
| 7740 | <div class="doc-copy"> | |
| 7741 | <section class="json-schema-properties"> | |
| 7742 | <dl> | |
| 7743 | <dt data-property-name="id"> | |
| 7744 | <span class="json-property-name">id:</span> | |
| 7745 | <span class="json-property-type">number</span> | |
| 7746 | <span class="json-property-range" title="Value limits"></span> | |
| 7747 | </dt> | |
| 7748 | <dt data-property-name="uuid"> | |
| 7749 | <span class="json-property-name">uuid:</span> | |
| 7750 | <span class="json-property-type">string</span> | |
| 7751 | <span class="json-property-range" title="Value limits"></span> | |
| 7752 | </dt> | |
| 7753 | </dl> | |
| 7754 | </section> | |
| 7755 | </div> | |
| 7756 | <div class="doc-examples"> | |
| 7757 | <section> | |
| 7758 | <h5>Example</h5> | |
| 7759 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7760 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7761 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
| 7762 | } | |
| 7763 | </code></pre> | |
| 7764 | <!-- </div> --> | |
| 7765 | </section> | |
| 7766 | </div> | |
| 7767 | </div> | |
| 7768 | </div> | |
| 7769 | <div id="definition-VideoUploadResponse" class="definition panel" data-traverse-target="definition-VideoUploadResponse"> | |
| 7770 | <h2 class="panel-title"> | |
| 7771 | <a name="/definitions/VideoUploadResponse"></a>VideoUploadResponse: | |
| 7772 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 7773 | <span class="json-property-range" title="Value limits"></span> | |
| 7774 | ||
| 7775 | ||
| 7776 | </span> --> | |
| 7777 | </h2> | |
| 7778 | <div class="doc-row"> | |
| 7779 | <div class="doc-copy"> | |
| 7780 | <section class="json-schema-properties"> | |
| 7781 | <dl> | |
| 61b66b36 C |
7782 | <dt data-property-name="video"> |
| 7783 | <span class="json-property-name">video:</span> | |
| 7784 | <span class="json-property-type">object</span> | |
| 5e1c08eb C |
7785 | <span class="json-property-range" title="Value limits"></span> |
| 7786 | </dt> | |
| ad9e39fb C |
7787 | <dt class="json-inner-schema"> |
| 7788 | <section class="json-schema-properties"> | |
| 7789 | <dl> | |
| 7790 | <dt data-property-name="id"> | |
| 7791 | <span class="json-property-name">id:</span> | |
| 7792 | <span class="json-property-type">number</span> | |
| 7793 | <span class="json-property-range" title="Value limits"></span> | |
| 7794 | </dt> | |
| 7795 | <dt data-property-name="uuid"> | |
| 7796 | <span class="json-property-name">uuid:</span> | |
| 7797 | <span class="json-property-type">string</span> | |
| 7798 | <span class="json-property-range" title="Value limits"></span> | |
| 7799 | </dt> | |
| 7800 | </dl> | |
| 7801 | </section> | |
| 7802 | </dt> | |
| 5e1c08eb C |
7803 | </dl> |
| 7804 | </section> | |
| 7805 | </div> | |
| 7806 | <div class="doc-examples"> | |
| 7807 | <section> | |
| 7808 | <h5>Example</h5> | |
| 7809 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 61b66b36 C |
7810 | <span class="hljs-attr">"video"</span>: { |
| 7811 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7812 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
| 7813 | } | |
| 5e1c08eb | 7814 | } |
| ab0ee6a1 C |
7815 | </code></pre> |
| 7816 | <!-- </div> --> | |
| 7817 | </section> | |
| 7818 | </div> | |
| 7819 | </div> | |
| 7820 | </div> | |
| 7821 | <div id="definition-CommentThreadResponse" class="definition panel" data-traverse-target="definition-CommentThreadResponse"> | |
| 7822 | <h2 class="panel-title"> | |
| 7823 | <a name="/definitions/CommentThreadResponse"></a>CommentThreadResponse: | |
| 7824 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 7825 | <span class="json-property-range" title="Value limits"></span> | |
| 7826 | ||
| 7827 | ||
| 7828 | </span> --> | |
| 7829 | </h2> | |
| 7830 | <div class="doc-row"> | |
| 7831 | <div class="doc-copy"> | |
| 7832 | <section class="json-schema-properties"> | |
| 7833 | <dl> | |
| 7834 | <dt data-property-name="total"> | |
| 7835 | <span class="json-property-name">total:</span> | |
| 7836 | <span class="json-property-type">number</span> | |
| 7837 | <span class="json-property-range" title="Value limits"></span> | |
| 7838 | </dt> | |
| 7839 | <dt data-property-name="data"> | |
| 7840 | <span class="json-property-name">data:</span> | |
| 7841 | <span class="json-property-type"> | |
| 7842 | <span class="json-schema-ref-array"> | |
| 7843 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | |
| 7844 | </span> | |
| 7845 | </span> | |
| 7846 | <span class="json-property-range" title="Value limits"></span> | |
| 7847 | </dt> | |
| ad9e39fb C |
7848 | <dt class="json-inner-schema"> |
| 7849 | <section class="json-schema-array-items"> | |
| 7850 | <span class="json-property-type"> | |
| 7851 | <span class=""> | |
| 7852 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | |
| 7853 | </span> | |
| 7854 | </span> | |
| 7855 | <span class="json-property-range" title="Value limits"></span> | |
| 7856 | <div class="json-inner-schema"> </div> | |
| 7857 | </section> | |
| 7858 | </dt> | |
| ab0ee6a1 C |
7859 | </dl> |
| 7860 | </section> | |
| 7861 | </div> | |
| 7862 | <div class="doc-examples"> | |
| 7863 | <section> | |
| 7864 | <h5>Example</h5> | |
| 7865 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7866 | <span class="hljs-attr">"total"</span>: <span class="hljs-string">"number"</span>, | |
| 7867 | <span class="hljs-attr">"data"</span>: [ | |
| 7868 | { | |
| 7869 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7870 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7871 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 7872 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 7873 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 7874 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 7875 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7876 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7877 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 7878 | <span class="hljs-attr">"account"</span>: { | |
| 7879 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 7880 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7881 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 7882 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7883 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 7884 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 7885 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7886 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7887 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7888 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7889 | <span class="hljs-attr">"avatar"</span>: { | |
| 7890 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 7891 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7892 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7893 | } | |
| 7894 | } | |
| 7895 | } | |
| 7896 | ] | |
| 7897 | } | |
| 7898 | </code></pre> | |
| 7899 | <!-- </div> --> | |
| 7900 | </section> | |
| 7901 | </div> | |
| 7902 | </div> | |
| 7903 | </div> | |
| 7904 | <div id="definition-CommentThreadPostResponse" class="definition panel" data-traverse-target="definition-CommentThreadPostResponse"> | |
| 7905 | <h2 class="panel-title"> | |
| 7906 | <a name="/definitions/CommentThreadPostResponse"></a>CommentThreadPostResponse: | |
| 7907 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 7908 | <span class="json-property-range" title="Value limits"></span> | |
| 7909 | ||
| 7910 | ||
| 7911 | </span> --> | |
| 7912 | </h2> | |
| 7913 | <div class="doc-row"> | |
| 7914 | <div class="doc-copy"> | |
| 7915 | <section class="json-schema-properties"> | |
| 7916 | <dl> | |
| 7917 | <dt data-property-name="comment"> | |
| 7918 | <span class="json-property-name">comment:</span> | |
| 7919 | <span class="json-property-type"> | |
| 7920 | <span class=""> | |
| 7921 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | |
| 7922 | </span> | |
| 7923 | </span> | |
| 7924 | <span class="json-property-range" title="Value limits"></span> | |
| 7925 | </dt> | |
| 7926 | </dl> | |
| 7927 | </section> | |
| 7928 | </div> | |
| 7929 | <div class="doc-examples"> | |
| 7930 | <section> | |
| 7931 | <h5>Example</h5> | |
| 7932 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7933 | <span class="hljs-attr">"comment"</span>: { | |
| 7934 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7935 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7936 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 7937 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 7938 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 7939 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 7940 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7941 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7942 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 7943 | <span class="hljs-attr">"account"</span>: { | |
| 7944 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 7945 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7946 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 7947 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7948 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 7949 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 7950 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7951 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7952 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7953 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7954 | <span class="hljs-attr">"avatar"</span>: { | |
| 7955 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 7956 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7957 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7958 | } | |
| 7959 | } | |
| 7960 | } | |
| 7961 | } | |
| 5e1c08eb C |
7962 | </code></pre> |
| 7963 | <!-- </div> --> | |
| 7964 | </section> | |
| 7965 | </div> | |
| 7966 | </div> | |
| 7967 | </div> | |
| 7968 | <div id="definition-AddUser" class="definition panel" data-traverse-target="definition-AddUser"> | |
| 7969 | <h2 class="panel-title"> | |
| 7970 | <a name="/definitions/AddUser"></a>AddUser: | |
| 7971 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 7972 | <span class="json-property-range" title="Value limits"></span> | |
| 7973 | ||
| 7974 | ||
| 7975 | </span> --> | |
| 7976 | </h2> | |
| 7977 | <div class="doc-row"> | |
| 7978 | <div class="doc-copy"> | |
| 7979 | <section class="json-schema-properties"> | |
| 7980 | <dl> | |
| 7981 | <dt data-property-name="username" class="has-description"> | |
| 7982 | <span class="json-property-name">username:</span> | |
| 7983 | <span class="json-property-type">string</span> | |
| 7984 | <span class="json-property-range" title="Value limits"></span> | |
| 7985 | <span class="json-property-required"></span> | |
| 7986 | </dt> | |
| 7987 | <dd> | |
| 7988 | <p>The user username </p> | |
| 7989 | </dd> | |
| 7990 | <dt data-property-name="password" class="has-description"> | |
| 7991 | <span class="json-property-name">password:</span> | |
| 7992 | <span class="json-property-type">string</span> | |
| 7993 | <span class="json-property-range" title="Value limits"></span> | |
| 7994 | <span class="json-property-required"></span> | |
| 7995 | </dt> | |
| 7996 | <dd> | |
| 7997 | <p>The user password </p> | |
| 7998 | </dd> | |
| 7999 | <dt data-property-name="email" class="has-description"> | |
| 8000 | <span class="json-property-name">email:</span> | |
| 8001 | <span class="json-property-type">string</span> | |
| 8002 | <span class="json-property-range" title="Value limits"></span> | |
| 8003 | <span class="json-property-required"></span> | |
| 8004 | </dt> | |
| 8005 | <dd> | |
| 8006 | <p>The user email </p> | |
| 8007 | </dd> | |
| 8008 | <dt data-property-name="videoQuota" class="has-description"> | |
| 8009 | <span class="json-property-name">videoQuota:</span> | |
| 8010 | <span class="json-property-type">string</span> | |
| 8011 | <span class="json-property-range" title="Value limits"></span> | |
| 8012 | <span class="json-property-required"></span> | |
| 8013 | </dt> | |
| 8014 | <dd> | |
| 8015 | <p>The user videoQuota </p> | |
| 8016 | </dd> | |
| 8017 | <dt data-property-name="role" class="has-description"> | |
| 8018 | <span class="json-property-name">role:</span> | |
| 8019 | <span class="json-property-type">string</span> | |
| 8020 | <span class="json-property-range" title="Value limits"></span> | |
| 8021 | <span class="json-property-required"></span> | |
| 8022 | </dt> | |
| 8023 | <dd> | |
| 8024 | <p>The user role </p> | |
| 8025 | </dd> | |
| 8026 | </dl> | |
| 8027 | </section> | |
| 8028 | </div> | |
| 8029 | <div class="doc-examples"> | |
| 8030 | <section> | |
| 8031 | <h5>Example</h5> | |
| 8032 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 8033 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
| 8034 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
| 8035 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 8036 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
| 8037 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
| 8038 | } | |
| 8039 | </code></pre> | |
| 8040 | <!-- </div> --> | |
| 8041 | </section> | |
| 8042 | </div> | |
| 8043 | </div> | |
| 8044 | </div> | |
| 8045 | <div id="definition-UpdateUser" class="definition panel" data-traverse-target="definition-UpdateUser"> | |
| 8046 | <h2 class="panel-title"> | |
| 8047 | <a name="/definitions/UpdateUser"></a>UpdateUser: | |
| 8048 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 8049 | <span class="json-property-range" title="Value limits"></span> | |
| 8050 | ||
| 8051 | ||
| 8052 | </span> --> | |
| 8053 | </h2> | |
| 8054 | <div class="doc-row"> | |
| 8055 | <div class="doc-copy"> | |
| 8056 | <section class="json-schema-properties"> | |
| 8057 | <dl> | |
| 8058 | <dt data-property-name="id" class="has-description"> | |
| 8059 | <span class="json-property-name">id:</span> | |
| 8060 | <span class="json-property-type">string</span> | |
| 8061 | <span class="json-property-range" title="Value limits"></span> | |
| 8062 | <span class="json-property-required"></span> | |
| 8063 | </dt> | |
| 8064 | <dd> | |
| 8065 | <p>The user id </p> | |
| 8066 | </dd> | |
| 8067 | <dt data-property-name="email" class="has-description"> | |
| 8068 | <span class="json-property-name">email:</span> | |
| 8069 | <span class="json-property-type">string</span> | |
| 8070 | <span class="json-property-range" title="Value limits"></span> | |
| 8071 | <span class="json-property-required"></span> | |
| 8072 | </dt> | |
| 8073 | <dd> | |
| 8074 | <p>The updated email of the user </p> | |
| 8075 | </dd> | |
| 8076 | <dt data-property-name="videoQuota" class="has-description"> | |
| 8077 | <span class="json-property-name">videoQuota:</span> | |
| 8078 | <span class="json-property-type">string</span> | |
| 8079 | <span class="json-property-range" title="Value limits"></span> | |
| 8080 | <span class="json-property-required"></span> | |
| 8081 | </dt> | |
| 8082 | <dd> | |
| 8083 | <p>The updated videoQuota of the user </p> | |
| 8084 | </dd> | |
| 8085 | <dt data-property-name="role" class="has-description"> | |
| 8086 | <span class="json-property-name">role:</span> | |
| 8087 | <span class="json-property-type">string</span> | |
| 8088 | <span class="json-property-range" title="Value limits"></span> | |
| 8089 | <span class="json-property-required"></span> | |
| 8090 | </dt> | |
| 8091 | <dd> | |
| 8092 | <p>The updated role of the user </p> | |
| 8093 | </dd> | |
| 8094 | </dl> | |
| 8095 | </section> | |
| 8096 | </div> | |
| 8097 | <div class="doc-examples"> | |
| 8098 | <section> | |
| 8099 | <h5>Example</h5> | |
| 8100 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 8101 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
| 8102 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 8103 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
| 8104 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
| 8105 | } | |
| 8106 | </code></pre> | |
| 8107 | <!-- </div> --> | |
| 8108 | </section> | |
| 8109 | </div> | |
| 8110 | </div> | |
| 8111 | </div> | |
| 8112 | <div id="definition-UpdateMe" class="definition panel" data-traverse-target="definition-UpdateMe"> | |
| 8113 | <h2 class="panel-title"> | |
| 8114 | <a name="/definitions/UpdateMe"></a>UpdateMe: | |
| 8115 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 8116 | <span class="json-property-range" title="Value limits"></span> | |
| 8117 | ||
| 8118 | ||
| 8119 | </span> --> | |
| 8120 | </h2> | |
| 8121 | <div class="doc-row"> | |
| 8122 | <div class="doc-copy"> | |
| 8123 | <section class="json-schema-properties"> | |
| 8124 | <dl> | |
| 8125 | <dt data-property-name="password" class="has-description"> | |
| 8126 | <span class="json-property-name">password:</span> | |
| 8127 | <span class="json-property-type">string</span> | |
| 8128 | <span class="json-property-range" title="Value limits"></span> | |
| 8129 | <span class="json-property-required"></span> | |
| 8130 | </dt> | |
| 8131 | <dd> | |
| 8132 | <p>Your new password </p> | |
| 8133 | </dd> | |
| 8134 | <dt data-property-name="email" class="has-description"> | |
| 8135 | <span class="json-property-name">email:</span> | |
| 8136 | <span class="json-property-type">string</span> | |
| 8137 | <span class="json-property-range" title="Value limits"></span> | |
| 8138 | <span class="json-property-required"></span> | |
| 8139 | </dt> | |
| 8140 | <dd> | |
| 8141 | <p>Your new email </p> | |
| 8142 | </dd> | |
| 8143 | <dt data-property-name="displayNSFW" class="has-description"> | |
| 8144 | <span class="json-property-name">displayNSFW:</span> | |
| 8145 | <span class="json-property-type">string</span> | |
| 8146 | <span class="json-property-range" title="Value limits"></span> | |
| 8147 | <span class="json-property-required"></span> | |
| 8148 | </dt> | |
| 8149 | <dd> | |
| 8150 | <p>Your new displayNSFW </p> | |
| 8151 | </dd> | |
| 8152 | <dt data-property-name="autoPlayVideo" class="has-description"> | |
| 8153 | <span class="json-property-name">autoPlayVideo:</span> | |
| 8154 | <span class="json-property-type">string</span> | |
| 8155 | <span class="json-property-range" title="Value limits"></span> | |
| 8156 | <span class="json-property-required"></span> | |
| 8157 | </dt> | |
| 8158 | <dd> | |
| 8159 | <p>Your new autoPlayVideo </p> | |
| 8160 | </dd> | |
| 8161 | </dl> | |
| 8162 | </section> | |
| 8163 | </div> | |
| 8164 | <div class="doc-examples"> | |
| 8165 | <section> | |
| 8166 | <h5>Example</h5> | |
| 8167 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 8168 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
| 8169 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 8170 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"string"</span>, | |
| 8171 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"string"</span> | |
| 8172 | } | |
| 8173 | </code></pre> | |
| 8174 | <!-- </div> --> | |
| 8175 | </section> | |
| 8176 | </div> | |
| 8177 | </div> | |
| 8178 | </div> | |
| 8179 | <div id="definition-GetMeVideoRating" class="definition panel" data-traverse-target="definition-GetMeVideoRating"> | |
| 8180 | <h2 class="panel-title"> | |
| 8181 | <a name="/definitions/GetMeVideoRating"></a>GetMeVideoRating: | |
| 8182 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 8183 | <span class="json-property-range" title="Value limits"></span> | |
| 8184 | ||
| 8185 | ||
| 8186 | </span> --> | |
| 8187 | </h2> | |
| 8188 | <div class="doc-row"> | |
| 8189 | <div class="doc-copy"> | |
| 8190 | <section class="json-schema-properties"> | |
| 8191 | <dl> | |
| 8192 | <dt data-property-name="id" class="has-description"> | |
| 8193 | <span class="json-property-name">id:</span> | |
| 8194 | <span class="json-property-type">string</span> | |
| 8195 | <span class="json-property-range" title="Value limits"></span> | |
| 8196 | <span class="json-property-required"></span> | |
| 8197 | </dt> | |
| 8198 | <dd> | |
| 8199 | <p>Id of the video </p> | |
| 8200 | </dd> | |
| 8201 | <dt data-property-name="rating" class="has-description"> | |
| 8202 | <span class="json-property-name">rating:</span> | |
| 8203 | <span class="json-property-type">number</span> | |
| 8204 | <span class="json-property-range" title="Value limits"></span> | |
| 8205 | <span class="json-property-required"></span> | |
| 8206 | </dt> | |
| 8207 | <dd> | |
| 8208 | <p>Rating of the video </p> | |
| 8209 | </dd> | |
| 8210 | </dl> | |
| 8211 | </section> | |
| 8212 | </div> | |
| 8213 | <div class="doc-examples"> | |
| 8214 | <section> | |
| 8215 | <h5>Example</h5> | |
| 8216 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 8217 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
| 8218 | <span class="hljs-attr">"rating"</span>: <span class="hljs-string">"number"</span> | |
| 8219 | } | |
| 8220 | </code></pre> | |
| 8221 | <!-- </div> --> | |
| 8222 | </section> | |
| 8223 | </div> | |
| 8224 | </div> | |
| 8225 | </div> | |
| 8226 | <div id="definition-RegisterUser" class="definition panel" data-traverse-target="definition-RegisterUser"> | |
| 8227 | <h2 class="panel-title"> | |
| 8228 | <a name="/definitions/RegisterUser"></a>RegisterUser: | |
| 8229 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 8230 | <span class="json-property-range" title="Value limits"></span> | |
| 8231 | ||
| 8232 | ||
| 8233 | </span> --> | |
| 8234 | </h2> | |
| 8235 | <div class="doc-row"> | |
| 8236 | <div class="doc-copy"> | |
| 8237 | <section class="json-schema-properties"> | |
| 8238 | <dl> | |
| 8239 | <dt data-property-name="username" class="has-description"> | |
| 8240 | <span class="json-property-name">username:</span> | |
| 8241 | <span class="json-property-type">string</span> | |
| 8242 | <span class="json-property-range" title="Value limits"></span> | |
| 8243 | <span class="json-property-required"></span> | |
| 8244 | </dt> | |
| 8245 | <dd> | |
| 8246 | <p>The username of the user </p> | |
| 8247 | </dd> | |
| 8248 | <dt data-property-name="password" class="has-description"> | |
| 8249 | <span class="json-property-name">password:</span> | |
| 8250 | <span class="json-property-type">string</span> | |
| 8251 | <span class="json-property-range" title="Value limits"></span> | |
| 8252 | <span class="json-property-required"></span> | |
| 8253 | </dt> | |
| 8254 | <dd> | |
| 8255 | <p>The password of the user </p> | |
| 8256 | </dd> | |
| 8257 | <dt data-property-name="email" class="has-description"> | |
| 8258 | <span class="json-property-name">email:</span> | |
| 8259 | <span class="json-property-type">string</span> | |
| 8260 | <span class="json-property-range" title="Value limits"></span> | |
| 8261 | <span class="json-property-required"></span> | |
| 8262 | </dt> | |
| 8263 | <dd> | |
| 8264 | <p>The email of the user </p> | |
| 8265 | </dd> | |
| 8266 | </dl> | |
| 8267 | </section> | |
| 8268 | </div> | |
| 8269 | <div class="doc-examples"> | |
| 8270 | <section> | |
| 8271 | <h5>Example</h5> | |
| 8272 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 8273 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
| 8274 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
| 8275 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span> | |
| 8276 | } | |
| 8277 | </code></pre> | |
| 8278 | <!-- </div> --> | |
| 8279 | </section> | |
| 8280 | </div> | |
| 8281 | </div> | |
| 8282 | </div> | |
| 8283 | <div id="definition-VideoChannelInput" class="definition panel" data-traverse-target="definition-VideoChannelInput"> | |
| 8284 | <h2 class="panel-title"> | |
| 8285 | <a name="/definitions/VideoChannelInput"></a>VideoChannelInput: | |
| 8286 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | |
| 8287 | <span class="json-property-range" title="Value limits"></span> | |
| 8288 | ||
| 8289 | ||
| 8290 | </span> --> | |
| 8291 | </h2> | |
| 8292 | <div class="doc-row"> | |
| 8293 | <div class="doc-copy"> | |
| 8294 | <section class="json-schema-properties"> | |
| 8295 | <dl> | |
| 8296 | <dt data-property-name="name"> | |
| 8297 | <span class="json-property-name">name:</span> | |
| 8298 | <span class="json-property-type">string</span> | |
| 8299 | <span class="json-property-range" title="Value limits"></span> | |
| 8300 | </dt> | |
| 8301 | <dt data-property-name="description"> | |
| 8302 | <span class="json-property-name">description:</span> | |
| 8303 | <span class="json-property-type">string</span> | |
| 8304 | <span class="json-property-range" title="Value limits"></span> | |
| 8305 | </dt> | |
| 8306 | </dl> | |
| 8307 | </section> | |
| 8308 | </div> | |
| 8309 | <div class="doc-examples"> | |
| 8310 | <section> | |
| 8311 | <h5>Example</h5> | |
| 8312 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 8313 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 8314 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span> | |
| 8315 | } | |
| 8316 | </code></pre> | |
| 8317 | <!-- </div> --> | |
| 8318 | </section> | |
| 8319 | </div> | |
| 8320 | </div> | |
| 8321 | </div> | |
| 8322 | <div class="doc-row no-margin"> | |
| 8323 | <div class="doc-copy doc-separator"> | |
| 8324 | <a class="powered-by" href="https://sourcey.com/spectacle">Documentation by | |
| 8325 | <span>Spectacle</span> | |
| 8326 | </a> | |
| 8327 | </div> | |
| 8328 | </div> | |
| 8329 | </article> | |
| 8330 | </div> | |
| 8331 | </div> | |
| 8332 | </body> | |
| 8333 | </html> |