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> | |
| 2963c343 | 28 | <a href="#operation--accounts--name--get"> Get the account by name </a> |
| 5e1c08eb | 29 | </li> |
| cc918ac3 | 30 | <li> |
| 2963c343 | 31 | <a href="#operation--accounts--name--videos-get"> Get videos for an account, provided the name of that account </a> |
| cc918ac3 | 32 | </li> |
| 5e1c08eb | 33 | <li> |
| 2963c343 | 34 | <a href="#operation--accounts-get"> Get all accounts </a> |
| 5e1c08eb C |
35 | </li> |
| 36 | </ul> | |
| 37 | </section> | |
| 38 | <section> | |
| 39 | <a href="#tag-Config">Config</a> | |
| 40 | <ul> | |
| 41 | <li> | |
| 2963c343 | 42 | <a href="#operation--config-get"> Get the configuration of the server </a> |
| 5e1c08eb C |
43 | </li> |
| 44 | </ul> | |
| 45 | </section> | |
| 48dce1c9 C |
46 | <section> |
| 47 | <a href="#tag-Feeds">Feeds</a> | |
| 48 | <ul> | |
| 49 | <li> | |
| 2963c343 | 50 | <a href="#operation--feeds-videos.-format--get"> Get the feed of videos for the server, with optional filter by account name or id </a> |
| 48dce1c9 C |
51 | </li> |
| 52 | </ul> | |
| 53 | </section> | |
| 5e1c08eb C |
54 | <section> |
| 55 | <a href="#tag-Job">Job</a> | |
| 56 | <ul> | |
| 57 | <li> | |
| 2963c343 | 58 | <a href="#operation--jobs-get"> Get list of jobs </a> |
| 5e1c08eb C |
59 | </li> |
| 60 | </ul> | |
| 61 | </section> | |
| 62 | <section> | |
| 63 | <a href="#tag-ServerFollowing">ServerFollowing</a> | |
| 64 | <ul> | |
| 65 | <li> | |
| 2963c343 | 66 | <a href="#operation--server-following--host--delete"> Unfollow a server by hostname </a> |
| 5e1c08eb C |
67 | </li> |
| 68 | <li> | |
| 2963c343 | 69 | <a href="#operation--server-followers-get"> Get followers of the server </a> |
| 5e1c08eb C |
70 | </li> |
| 71 | <li> | |
| 2963c343 | 72 | <a href="#operation--server-following-get"> Get servers followed by the server </a> |
| 5e1c08eb C |
73 | </li> |
| 74 | <li> | |
| 2963c343 | 75 | <a href="#operation--server-following-post"> Follow a server </a> |
| 5e1c08eb C |
76 | </li> |
| 77 | </ul> | |
| 78 | </section> | |
| 79 | <section> | |
| 2963c343 RK |
80 | <a href="#tag-VideoAbuse">VideoAbuse</a> |
| 81 | <ul> | |
| 82 | <li> | |
| 83 | <a href="#operation--videos-abuse-get"> Get list of reported video abuses </a> | |
| 84 | </li> | |
| 85 | <li> | |
| 86 | <a href="#operation--videos--id--abuse-post"> Report an abuse, on a video by its id </a> | |
| 87 | </li> | |
| 88 | </ul> | |
| 89 | </section> | |
| 90 | <section> | |
| 91 | <a href="#tag-Video">Video</a> | |
| 5e1c08eb C |
92 | <ul> |
| 93 | <li> | |
| 2963c343 | 94 | <a href="#operation--accounts--name--videos-get"> Get videos for an account, provided the name of that account </a> |
| 5e1c08eb C |
95 | </li> |
| 96 | <li> | |
| 2963c343 | 97 | <a href="#operation--videos-get"> Get list of videos </a> |
| 5e1c08eb C |
98 | </li> |
| 99 | <li> | |
| 2963c343 | 100 | <a href="#operation--videos-categories-get"> Get list of video licences known by the server </a> |
| 5e1c08eb C |
101 | </li> |
| 102 | <li> | |
| 2963c343 | 103 | <a href="#operation--videos-licences-get"> Get list of video licences known by the server </a> |
| 5e1c08eb C |
104 | </li> |
| 105 | <li> | |
| 2963c343 | 106 | <a href="#operation--videos-languages-get"> Get list of languages known by the server </a> |
| 5e1c08eb C |
107 | </li> |
| 108 | <li> | |
| 2963c343 | 109 | <a href="#operation--videos-privacies-get"> Get list of privacy policies supported by the server </a> |
| 5e1c08eb C |
110 | </li> |
| 111 | <li> | |
| 2963c343 | 112 | <a href="#operation--videos--id--put"> Update metadata for a video by its id </a> |
| 5e1c08eb C |
113 | </li> |
| 114 | <li> | |
| 2963c343 | 115 | <a href="#operation--videos--id--get"> Get a video by its id </a> |
| 5e1c08eb C |
116 | </li> |
| 117 | <li> | |
| 2963c343 | 118 | <a href="#operation--videos--id--delete"> Delete a video by its id </a> |
| 5e1c08eb C |
119 | </li> |
| 120 | <li> | |
| 2963c343 | 121 | <a href="#operation--videos--id--description-get"> Get a video description by its id </a> |
| 5e1c08eb C |
122 | </li> |
| 123 | <li> | |
| 2963c343 | 124 | <a href="#operation--videos--id--views-post"> Add a view to the video by its id </a> |
| 5e1c08eb C |
125 | </li> |
| 126 | <li> | |
| 2963c343 | 127 | <a href="#operation--videos-upload-post"> Upload a video file with its metadata </a> |
| 5e1c08eb C |
128 | </li> |
| 129 | </ul> | |
| 130 | </section> | |
| 131 | <section> | |
| 2963c343 | 132 | <a href="#tag-Search">Search</a> |
| 5e1c08eb C |
133 | <ul> |
| 134 | <li> | |
| 2963c343 | 135 | <a href="#operation--search-videos-get"> Get the videos corresponding to a given query </a> |
| 5e1c08eb | 136 | </li> |
| 2963c343 RK |
137 | </ul> |
| 138 | </section> | |
| 139 | <section> | |
| 140 | <a href="#tag-VideoComment">VideoComment</a> | |
| 141 | <ul> | |
| 5e1c08eb | 142 | <li> |
| 2963c343 | 143 | <a href="#operation--videos--id--comment-threads-get"> Get the comment threads of a video by its id </a> |
| 5e1c08eb C |
144 | </li> |
| 145 | <li> | |
| 2963c343 | 146 | <a href="#operation--videos--id--comment-threads-post"> Creates a comment thread, on a video by its id </a> |
| 5e1c08eb C |
147 | </li> |
| 148 | <li> | |
| 2963c343 | 149 | <a href="#operation--videos--id--comment-threads--threadId--get"> Get the comment thread by its id, of a video by its id </a> |
| 5e1c08eb C |
150 | </li> |
| 151 | <li> | |
| 2963c343 | 152 | <a href="#operation--videos--id--comments--commentId--post"> Creates a comment in a comment thread by its id, of a video by its id </a> |
| 5e1c08eb | 153 | </li> |
| 5e1c08eb | 154 | <li> |
| 2963c343 | 155 | <a href="#operation--videos--id--comments--commentId--delete"> Delete a comment in a comment therad by its id, of a video by its id </a> |
| 5e1c08eb | 156 | </li> |
| 2963c343 RK |
157 | </ul> |
| 158 | </section> | |
| 159 | <section> | |
| 160 | <a href="#tag-VideoChannel">VideoChannel</a> | |
| 161 | <ul> | |
| 5e1c08eb | 162 | <li> |
| 2963c343 | 163 | <a href="#operation--video-channels-get"> Get list of video channels </a> |
| 5e1c08eb C |
164 | </li> |
| 165 | <li> | |
| 2963c343 | 166 | <a href="#operation--video-channels-post"> Creates a video channel for the current user </a> |
| 5e1c08eb C |
167 | </li> |
| 168 | <li> | |
| 2963c343 | 169 | <a href="#operation--video-channels--id--get"> Get a video channel by its id </a> |
| 5e1c08eb C |
170 | </li> |
| 171 | <li> | |
| 2963c343 | 172 | <a href="#operation--video-channels--id--put"> Update a video channel by its id </a> |
| 5e1c08eb C |
173 | </li> |
| 174 | <li> | |
| 2963c343 | 175 | <a href="#operation--video-channels--id--delete"> Delete a video channel by its id </a> |
| 5e1c08eb | 176 | </li> |
| 5e1c08eb | 177 | <li> |
| 2963c343 | 178 | <a href="#operation--video-channels--id--videos-get"> Get videos of a video channel by its id </a> |
| 5e1c08eb C |
179 | </li> |
| 180 | <li> | |
| 2963c343 | 181 | <a href="#operation--accounts--name--video-channels-get"> Get video channels of an account by its name </a> |
| 5e1c08eb C |
182 | </li> |
| 183 | </ul> | |
| 184 | </section> | |
| 185 | <section> | |
| 2963c343 | 186 | <a href="#tag-User">User</a> |
| 5e1c08eb C |
187 | <ul> |
| 188 | <li> | |
| 2963c343 | 189 | <a href="#operation--users-post"> Creates user </a> |
| 5e1c08eb C |
190 | </li> |
| 191 | <li> | |
| 2963c343 | 192 | <a href="#operation--users-get"> Get a list of users </a> |
| 5e1c08eb C |
193 | </li> |
| 194 | <li> | |
| 2963c343 | 195 | <a href="#operation--users--id--delete"> Delete a user by its id </a> |
| 5e1c08eb | 196 | </li> |
| 5e1c08eb | 197 | <li> |
| 2963c343 | 198 | <a href="#operation--users--id--get"> Get user by its id </a> |
| 5e1c08eb C |
199 | </li> |
| 200 | <li> | |
| 2963c343 | 201 | <a href="#operation--users--id--put"> Update user profile by its id </a> |
| cc918ac3 C |
202 | </li> |
| 203 | <li> | |
| 2963c343 | 204 | <a href="#operation--users-me-get"> Get current user information </a> |
| 5e1c08eb C |
205 | </li> |
| 206 | <li> | |
| 2963c343 | 207 | <a href="#operation--users-me-put"> Update current user information </a> |
| 5e1c08eb C |
208 | </li> |
| 209 | <li> | |
| 2963c343 | 210 | <a href="#operation--users-me-video-quota-used-get"> Get current user used quota </a> |
| 5e1c08eb C |
211 | </li> |
| 212 | <li> | |
| 2963c343 | 213 | <a href="#operation--users-me-videos--videoId--rating-get"> Get rating of video by its id, among those of the current user </a> |
| 5e1c08eb C |
214 | </li> |
| 215 | <li> | |
| 2963c343 | 216 | <a href="#operation--users-me-videos-get"> Get videos of the current user </a> |
| 5e1c08eb | 217 | </li> |
| 5e1c08eb | 218 | <li> |
| 2963c343 | 219 | <a href="#operation--users-register-post"> Register a user </a> |
| 5e1c08eb C |
220 | </li> |
| 221 | <li> | |
| 2963c343 | 222 | <a href="#operation--users-me-avatar-pick-post"> Update current user avatar </a> |
| 5e1c08eb | 223 | </li> |
| 2963c343 RK |
224 | </ul> |
| 225 | </section> | |
| 226 | <section> | |
| 227 | <a href="#tag-VideoBlacklist">VideoBlacklist</a> | |
| 228 | <ul> | |
| 5e1c08eb | 229 | <li> |
| 2963c343 | 230 | <a href="#operation--videos--id--blacklist-post"> Put on blacklist a video by its id </a> |
| 5e1c08eb C |
231 | </li> |
| 232 | <li> | |
| 2963c343 | 233 | <a href="#operation--videos--id--blacklist-delete"> Delete an entry of the blacklist of a video by its id </a> |
| 5e1c08eb C |
234 | </li> |
| 235 | <li> | |
| 2963c343 | 236 | <a href="#operation--videos-blacklist-get"> Get list of videos on blacklist </a> |
| 5e1c08eb C |
237 | </li> |
| 238 | </ul> | |
| 239 | </section> | |
| 240 | <section> | |
| 241 | <a href="#tag-VideoRate">VideoRate</a> | |
| 242 | <ul> | |
| 243 | <li> | |
| 2963c343 | 244 | <a href="#operation--videos--id--rate-put"> Vote for a video by its id </a> |
| fb72c193 DL |
245 | </li> |
| 246 | </ul> | |
| 247 | </section> | |
| 5e1c08eb | 248 | <h5>Schema Definitions</h5> |
| 48dce1c9 C |
249 | <a href="#definition-VideoConstantNumber"> VideoConstantNumber </a> |
| 250 | <a href="#definition-VideoConstantString"> VideoConstantString </a> | |
| 61b66b36 | 251 | <a href="#definition-VideoPrivacy"> VideoPrivacy </a> |
| 5e1c08eb C |
252 | <a href="#definition-Video"> Video </a> |
| 253 | <a href="#definition-VideoAbuse"> VideoAbuse </a> | |
| 254 | <a href="#definition-VideoBlacklist"> VideoBlacklist </a> | |
| 255 | <a href="#definition-VideoChannel"> VideoChannel </a> | |
| 256 | <a href="#definition-VideoComment"> VideoComment </a> | |
| 257 | <a href="#definition-VideoCommentThreadTree"> VideoCommentThreadTree </a> | |
| 258 | <a href="#definition-Avatar"> Avatar </a> | |
| 259 | <a href="#definition-Actor"> Actor </a> | |
| 260 | <a href="#definition-Account"> Account </a> | |
| 261 | <a href="#definition-User"> User </a> | |
| 262 | <a href="#definition-ServerConfig"> ServerConfig </a> | |
| 263 | <a href="#definition-Follow"> Follow </a> | |
| 264 | <a href="#definition-Job"> Job </a> | |
| 265 | <a href="#definition-AddUserResponse"> AddUserResponse </a> | |
| 266 | <a href="#definition-VideoUploadResponse"> VideoUploadResponse </a> | |
| ab0ee6a1 C |
267 | <a href="#definition-CommentThreadResponse"> CommentThreadResponse </a> |
| 268 | <a href="#definition-CommentThreadPostResponse"> CommentThreadPostResponse </a> | |
| 5e1c08eb C |
269 | <a href="#definition-AddUser"> AddUser </a> |
| 270 | <a href="#definition-UpdateUser"> UpdateUser </a> | |
| 271 | <a href="#definition-UpdateMe"> UpdateMe </a> | |
| 272 | <a href="#definition-GetMeVideoRating"> GetMeVideoRating </a> | |
| 273 | <a href="#definition-RegisterUser"> RegisterUser </a> | |
| 274 | <a href="#definition-VideoChannelInput"> VideoChannelInput </a> | |
| 275 | </nav> | |
| 276 | </div> | |
| 277 | <div id="docs" class="row collapse expanded drawer" data-drawer> | |
| 278 | <button class="floating-menu-icon" type="button" data-drawer-slide="right"> | |
| 279 | <span class="hamburger"></span> | |
| 280 | </button> | |
| 281 | <div class="example-box doc-content"></div> | |
| 282 | <article> | |
| 228e84aa C |
283 | <h1 class="doc-title">PeerTube |
| 284 | <span>API Reference</span> | |
| 285 | </h1> | |
| 5e1c08eb | 286 | <div id="introduction" data-traverse-target="introduction"> |
| 5e1c08eb C |
287 | <div class="doc-row"> |
| 288 | <div class="doc-copy"> | |
| 2963c343 RK |
289 | <h1 id="introduction">Introduction</h1> |
| 290 | <p>The PeerTube API is built on HTTP(S). Our API is RESTful. It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. You can use your favorite HTTP/REST library for your programming language to use PeerTube. No official SDK is currently provided.</p> | |
| 291 | <h1 id="authentication">Authentication</h1> | |
| 292 | <p>When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time.</p> | |
| 5e1c08eb C |
293 | </div> |
| 294 | <div class="doc-examples"> | |
| 295 | <section> | |
| ea65a476 C |
296 | <h5>API Endpoint</h5> |
| 297 | <!-- <div class="hljs"> --><pre><code>https://peertube.example.com/api/v1</code></pre> | |
| 298 | <!-- </div> --> | |
| 2963c343 RK |
299 | <h5>Request Content-Types: |
| 300 | <span>application/json</span> | |
| 301 | </h5> | |
| 302 | <h5>Response Content-Types: | |
| 303 | <span>application/json; charset=utf-8</span> | |
| 304 | </h5> | |
| ea65a476 C |
305 | <h5>Schemes: |
| 306 | <span>https</span> | |
| 307 | </h5> | |
| 5e1c08eb | 308 | <h5>Version: |
| 2963c343 | 309 | <span>1.1.0-alpha.2</span> |
| 5e1c08eb C |
310 | </h5> |
| 311 | </section> | |
| 312 | </div> | |
| 313 | </div> | |
| 314 | </div> | |
| 94ff4c23 C |
315 | <!-- <h1 id="security" data-traverse-target="security">Security</h1> --> |
| 316 | <h1 id="authentication" data-traverse-target="authentication">Authentication</h1> | |
| 317 | <div id="security-definition-OAuth2" class="panel"> | |
| 318 | <div class="doc-row"> | |
| 319 | <div class="doc-copy"> | |
| 320 | <h3 class="security-definition-title"> | |
| 321 | <span class="security-name">OAuth2</span> | |
| 322 | <span class="swagger-security-definition-oauth2"></span> | |
| 323 | </h3> | |
| 324 | <section class="security-definition-description"> | |
| 325 | <p>In the header: | |
| 2963c343 | 326 | <em>Authorization: Bearer <token></em> |
| 94ff4c23 | 327 | </p> |
| 2963c343 RK |
328 | <p>Authenticating via OAuth requires the following steps:</p> |
| 329 | <ul> | |
| 330 | <li>Have an account with sufficient authorization levels</li> | |
| 331 | <li> | |
| 332 | <a href="https://docs.joinpeertube.org/lang/en/devdocs/rest.html">Generate</a> a Bearer Token</li> | |
| 333 | <li>Make Authenticated Requests</li> | |
| 334 | </ul> | |
| 94ff4c23 C |
335 | </section> |
| 336 | <section class="swagger-security-definition-properties"> | |
| 337 | <div class="prop-row security-definition-property"> | |
| 338 | <div class="prop-name"> | |
| 339 | <div class="prop-title security-definition-property-name">type</div> | |
| 340 | </div> | |
| 341 | <div class="prop-value security-definition-property-type"> oauth2 </div> | |
| 342 | </div> | |
| 343 | <div class="prop-row security-definition-property"> | |
| 344 | <div class="prop-name"> | |
| 345 | <div class="prop-title security-definition-property-name">flow</div> | |
| 346 | </div> | |
| 347 | <div class="prop-value security-definition-property-type"> password </div> | |
| 348 | </div> | |
| 349 | <div class="prop-row security-definition-property"> | |
| 350 | <div class="prop-name"> | |
| 351 | <div class="prop-title security-definition-property-name">tokenUrl</div> | |
| 352 | </div> | |
| 353 | <div class="prop-value security-definition-property-type"> https://peertube.example.com/api/v1/users/token </div> | |
| 354 | </div> | |
| 2963c343 RK |
355 | <div class="prop-row security-definition-property"> |
| 356 | <div class="prop-name"> | |
| 357 | <div class="prop-title security-definition-property-name">scopes</div> | |
| 358 | </div> | |
| 359 | <div class="prop-value security-definition-property-type"> | |
| 360 | <span id="security-definition-scope-admin">admin</span> | |
| 361 | <p class="security-definition-scope-description">Admin scope</p> | |
| 362 | <span id="security-definition-scope-moderator">moderator</span> | |
| 363 | <p class="security-definition-scope-description">Moderator scope</p> | |
| 364 | <span id="security-definition-scope-user">user</span> | |
| 365 | <p class="security-definition-scope-description">User scope</p> | |
| 366 | </div> | |
| 367 | </div> | |
| 94ff4c23 C |
368 | </section> |
| 369 | </div> | |
| 370 | </div> | |
| 371 | </div> | |
| 5e1c08eb | 372 | <h1 id="tag-Accounts" class="swagger-summary-tag" data-traverse-target="tag-Accounts">Accounts</h1> |
| 2963c343 RK |
373 | <div class="tag-description doc-row"> |
| 374 | <div class="doc-copy"> | |
| 375 | <p>Using some features of PeerTube require authentication, for which Accounts provide different levels of permission as well as associated user information. Accounts also encompass remote accounts discovered across the federation.</p> | |
| 376 | </div> | |
| 377 | </div> | |
| ad9e39fb | 378 | <div id="operation--accounts--name--get" class="operation panel" data-traverse-target="operation--accounts--name--get"> |
| 5e1c08eb C |
379 | <!-- <section class="operation-tags row"> --> |
| 380 | <!-- <div class="doc-copy"> --> | |
| 381 | <div class="operation-tags"> | |
| 382 | <a class="label" href="#tag-Accounts">Accounts</a> | |
| 383 | <!----> | |
| 384 | </div> | |
| 385 | <!-- </div> --> | |
| 386 | <!-- </section> --> | |
| 387 | <h2 class="operation-title"> | |
| 2963c343 | 388 | <span class="operation-summary">Get the account by name</span> |
| 5e1c08eb | 389 | </h2> |
| 2963c343 RK |
390 | <div class="doc-row"> |
| 391 | <div class="doc-copy"> | |
| 392 | <section class="swagger-operation-path"> | |
| 393 | <span class="operation-method">GET</span> | |
| 394 | <span class="operation-path">/accounts/{name}</span> | |
| 395 | </section> | |
| 396 | </div> | |
| 397 | </div> | |
| 5e1c08eb C |
398 | <div class="doc-row"> |
| 399 | <div class="doc-copy"> | |
| 400 | <section class="swagger-request-params"> | |
| 401 | <div class="prop-row prop-group"> | |
| 402 | <div class="prop-name"> | |
| 330eaf12 C |
403 | <div class="prop-title">name: |
| 404 | <span class="prop-type"> | |
| 405 | <span class="json-property-type">string</span> | |
| 406 | <span class="json-property-range" title="Value limits"></span> | |
| 407 | </span> | |
| 408 | </div> | |
| 5e1c08eb | 409 | <span class="json-property-required"></span> |
| 228e84aa | 410 | <div class="prop-subtitle"> in path </div> |
| 5e1c08eb C |
411 | </div> |
| 412 | <div class="prop-value"> | |
| ad9e39fb C |
413 | <p>The name of the account (chocobozzz or |
| 414 | <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p> | |
| 5e1c08eb C |
415 | </div> |
| 416 | </div> | |
| ab0ee6a1 C |
417 | <div class="prop-row prop-group"> |
| 418 | <div class="prop-name"> | |
| 330eaf12 C |
419 | <div class="prop-title">start: |
| 420 | <span class="prop-type"> | |
| 421 | <span class="json-property-type">number</span> | |
| 422 | <span class="json-property-range" title="Value limits"></span> | |
| 423 | </span> | |
| 228e84aa | 424 | </div> |
| 330eaf12 | 425 | <div class="prop-subtitle"> in query </div> |
| ab0ee6a1 C |
426 | </div> |
| 427 | <div class="prop-value"> | |
| 330eaf12 | 428 | <p>Offset</p> |
| ab0ee6a1 C |
429 | </div> |
| 430 | </div> | |
| ab0ee6a1 C |
431 | <div class="prop-row prop-group"> |
| 432 | <div class="prop-name"> | |
| 330eaf12 C |
433 | <div class="prop-title">count: |
| 434 | <span class="prop-type"> | |
| 435 | <span class="json-property-type">number</span> | |
| 436 | <span class="json-property-range" title="Value limits"></span> | |
| 437 | </span> | |
| 228e84aa | 438 | </div> |
| 330eaf12 | 439 | <div class="prop-subtitle"> in query </div> |
| ab0ee6a1 C |
440 | </div> |
| 441 | <div class="prop-value"> | |
| 330eaf12 | 442 | <p>Number of items</p> |
| ab0ee6a1 C |
443 | </div> |
| 444 | </div> | |
| ab0ee6a1 C |
445 | <div class="prop-row prop-group"> |
| 446 | <div class="prop-name"> | |
| 330eaf12 C |
447 | <div class="prop-title">sort: |
| 448 | <span class="prop-type"> | |
| 449 | <span class="json-property-type">string</span> | |
| 450 | <span class="json-property-range" title="Value limits"></span> | |
| 451 | </span> | |
| 228e84aa | 452 | </div> |
| 330eaf12 | 453 | <div class="prop-subtitle"> in query </div> |
| ab0ee6a1 C |
454 | </div> |
| 455 | <div class="prop-value"> | |
| 330eaf12 | 456 | <p>Sort column (-createdAt for example)</p> |
| ab0ee6a1 C |
457 | </div> |
| 458 | </div> | |
| 5e1c08eb C |
459 | </section> |
| 460 | </div> | |
| 461 | <div class="doc-examples"></div> | |
| 462 | </div> | |
| 463 | <div class="doc-row"> | |
| 464 | <div class="doc-copy"> | |
| 465 | <section class="swagger-responses"> | |
| 466 | <div class="prop-row prop-group"> | |
| 467 | <div class="prop-name"> | |
| 468 | <div class="prop-title">200 OK</div> | |
| 469 | <div class="prop-ref"> | |
| 470 | <span class=""> | |
| 471 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
| 472 | </span> | |
| 473 | </div> | |
| 474 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 475 | </div> | |
| 476 | <div class="prop-value"> | |
| 477 | <p>successful operation</p> | |
| 478 | </div> | |
| 479 | </div> | |
| 480 | </section> | |
| 481 | </div> | |
| 482 | <div class="doc-examples"> | |
| 483 | <h5>Response Content-Types: | |
| 484 | <span>application/json</span> | |
| 485 | </h5> | |
| 486 | <section> | |
| 487 | <h5>Response Example | |
| 488 | <span>(200 OK)</span> | |
| 489 | </h5> | |
| 490 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 491 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 492 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 493 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 494 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 495 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 496 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 497 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 498 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 499 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 500 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 501 | <span class="hljs-attr">"avatar"</span>: { | |
| 502 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 503 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 504 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 505 | } | |
| 506 | } | |
| cc918ac3 C |
507 | </code></pre> |
| 508 | <!-- </div> --> | |
| 509 | </section> | |
| 510 | </div> | |
| 511 | </div> | |
| 512 | </div> | |
| ad9e39fb | 513 | <div id="operation--accounts--name--videos-get" class="operation panel" data-traverse-target="operation--accounts--name--videos-get"> |
| cc918ac3 C |
514 | <!-- <section class="operation-tags row"> --> |
| 515 | <!-- <div class="doc-copy"> --> | |
| 516 | <div class="operation-tags"> | |
| 517 | <a class="label" href="#tag-Accounts">Accounts</a> | |
| 2963c343 RK |
518 | <!--, --> |
| 519 | <a class="label" href="#tag-Video">Video</a> | |
| cc918ac3 C |
520 | <!----> |
| 521 | </div> | |
| 522 | <!-- </div> --> | |
| 523 | <!-- </section> --> | |
| 524 | <h2 class="operation-title"> | |
| 2963c343 | 525 | <span class="operation-summary">Get videos for an account, provided the name of that account</span> |
| cc918ac3 | 526 | </h2> |
| 2963c343 RK |
527 | <div class="doc-row"> |
| 528 | <div class="doc-copy"> | |
| 529 | <section class="swagger-operation-path"> | |
| 530 | <span class="operation-method">GET</span> | |
| 531 | <span class="operation-path">/accounts/{name}/videos</span> | |
| 532 | </section> | |
| 533 | </div> | |
| 534 | </div> | |
| cc918ac3 C |
535 | <div class="doc-row"> |
| 536 | <div class="doc-copy"> | |
| 537 | <section class="swagger-request-params"> | |
| 538 | <div class="prop-row prop-group"> | |
| 539 | <div class="prop-name"> | |
| 330eaf12 C |
540 | <div class="prop-title">name: |
| 541 | <span class="prop-type"> | |
| 542 | <span class="json-property-type">string</span> | |
| 543 | <span class="json-property-range" title="Value limits"></span> | |
| 544 | </span> | |
| 545 | </div> | |
| cc918ac3 C |
546 | <span class="json-property-required"></span> |
| 547 | <div class="prop-subtitle"> in path </div> | |
| cc918ac3 C |
548 | </div> |
| 549 | <div class="prop-value"> | |
| ad9e39fb C |
550 | <p>The name of the account (chocobozzz or |
| 551 | <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p> | |
| cc918ac3 C |
552 | </div> |
| 553 | </div> | |
| 554 | </section> | |
| 555 | </div> | |
| 556 | <div class="doc-examples"></div> | |
| 557 | </div> | |
| 558 | <div class="doc-row"> | |
| 559 | <div class="doc-copy"> | |
| 560 | <section class="swagger-responses"> | |
| 561 | <div class="prop-row prop-group"> | |
| 562 | <div class="prop-name"> | |
| 563 | <div class="prop-title">200 OK</div> | |
| 564 | <div class="prop-ref"> | |
| 565 | <span class=""> | |
| 566 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
| 567 | </span> | |
| 568 | </div> | |
| 569 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 570 | </div> | |
| 571 | <div class="prop-value"> | |
| 572 | <p>successful operation</p> | |
| 573 | </div> | |
| 574 | </div> | |
| 575 | </section> | |
| 576 | </div> | |
| 577 | <div class="doc-examples"> | |
| 578 | <h5>Response Content-Types: | |
| 579 | <span>application/json</span> | |
| 580 | </h5> | |
| 581 | <section> | |
| 582 | <h5>Response Example | |
| 583 | <span>(200 OK)</span> | |
| 584 | </h5> | |
| 585 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 586 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 587 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 588 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 589 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 590 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 591 | <span class="hljs-attr">"category"</span>: { | |
| 592 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 593 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 594 | }, | |
| 595 | <span class="hljs-attr">"licence"</span>: { | |
| 596 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 597 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 598 | }, | |
| 599 | <span class="hljs-attr">"language"</span>: { | |
| 600 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
| 601 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 602 | }, | |
| 603 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | |
| 604 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 605 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 606 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 607 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 608 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
| 609 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
| 610 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
| 611 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 612 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 613 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 614 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | |
| 615 | <span class="hljs-attr">"account"</span>: { | |
| 616 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 617 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 618 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 619 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 620 | <span class="hljs-attr">"avatar"</span>: { | |
| 621 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 622 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 623 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 624 | } | |
| 625 | } | |
| 626 | } | |
| 5e1c08eb C |
627 | </code></pre> |
| 628 | <!-- </div> --> | |
| 629 | </section> | |
| 630 | </div> | |
| 631 | </div> | |
| 632 | </div> | |
| 633 | <div id="operation--accounts-get" class="operation panel" data-traverse-target="operation--accounts-get"> | |
| 634 | <!-- <section class="operation-tags row"> --> | |
| 635 | <!-- <div class="doc-copy"> --> | |
| 636 | <div class="operation-tags"> | |
| 637 | <a class="label" href="#tag-Accounts">Accounts</a> | |
| 638 | <!----> | |
| 639 | </div> | |
| 640 | <!-- </div> --> | |
| 641 | <!-- </section> --> | |
| 642 | <h2 class="operation-title"> | |
| 2963c343 | 643 | <span class="operation-summary">Get all accounts</span> |
| 5e1c08eb | 644 | </h2> |
| 2963c343 RK |
645 | <div class="doc-row"> |
| 646 | <div class="doc-copy"> | |
| 647 | <section class="swagger-operation-path"> | |
| 648 | <span class="operation-method">GET</span> | |
| 649 | <span class="operation-path">/accounts</span> | |
| 650 | </section> | |
| 651 | </div> | |
| 652 | </div> | |
| 5e1c08eb C |
653 | <div class="doc-row"> |
| 654 | <div class="doc-copy"> </div> | |
| 655 | <div class="doc-examples"></div> | |
| 656 | </div> | |
| 657 | <div class="doc-row"> | |
| 658 | <div class="doc-copy"> | |
| 659 | <section class="swagger-responses"> | |
| 660 | <div class="prop-row prop-group"> | |
| 661 | <div class="prop-name"> | |
| 662 | <div class="prop-title">200 OK</div> | |
| 663 | <div class="prop-ref"> | |
| 664 | <span class="json-schema-ref-array"> | |
| 665 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
| 666 | </span> | |
| 667 | </div> | |
| 668 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 669 | </div> | |
| 670 | <div class="prop-value"> | |
| 671 | <p>successful operation</p> | |
| 672 | </div> | |
| 673 | </div> | |
| 228e84aa C |
674 | <div class="prop-row prop-inner"> |
| 675 | <div class="prop-name">type</div> | |
| 676 | <div class="prop-value"> | |
| 677 | <span class="json-property-type"> | |
| 678 | <span class="json-schema-ref-array"> | |
| 679 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
| 680 | </span> | |
| 681 | </span> | |
| 682 | <span class="json-property-range" title="Value limits"></span> | |
| 683 | </div> | |
| 684 | </div> | |
| 5e1c08eb C |
685 | </section> |
| 686 | </div> | |
| 687 | <div class="doc-examples"> | |
| 688 | <h5>Response Content-Types: | |
| 2963c343 | 689 | <span>application/jsonhttps://peertube.cpy.re/api/v1</span> |
| 5e1c08eb C |
690 | </h5> |
| 691 | <section> | |
| 692 | <h5>Response Example | |
| 693 | <span>(200 OK)</span> | |
| 694 | </h5> | |
| 695 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 696 | { | |
| 697 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 698 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 699 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 700 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 701 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 702 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 703 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 704 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 705 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 706 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 707 | <span class="hljs-attr">"avatar"</span>: { | |
| 708 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 709 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 710 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 711 | } | |
| 712 | } | |
| 713 | ] | |
| 714 | </code></pre> | |
| 715 | <!-- </div> --> | |
| 716 | </section> | |
| 717 | </div> | |
| 718 | </div> | |
| 719 | </div> | |
| 720 | <h1 id="tag-Config" class="swagger-summary-tag" data-traverse-target="tag-Config">Config</h1> | |
| 2963c343 RK |
721 | <div class="tag-description doc-row"> |
| 722 | <div class="doc-copy"> | |
| 723 | <p>Each server exposes public information regarding supported videos and options.</p> | |
| 724 | </div> | |
| 725 | </div> | |
| 5e1c08eb C |
726 | <div id="operation--config-get" class="operation panel" data-traverse-target="operation--config-get"> |
| 727 | <!-- <section class="operation-tags row"> --> | |
| 728 | <!-- <div class="doc-copy"> --> | |
| 729 | <div class="operation-tags"> | |
| 730 | <a class="label" href="#tag-Config">Config</a> | |
| 731 | <!----> | |
| 732 | </div> | |
| 733 | <!-- </div> --> | |
| 734 | <!-- </section> --> | |
| 735 | <h2 class="operation-title"> | |
| 2963c343 | 736 | <span class="operation-summary">Get the configuration of the server</span> |
| 5e1c08eb | 737 | </h2> |
| 2963c343 RK |
738 | <div class="doc-row"> |
| 739 | <div class="doc-copy"> | |
| 740 | <section class="swagger-operation-path"> | |
| 741 | <span class="operation-method">GET</span> | |
| 742 | <span class="operation-path">/config</span> | |
| 743 | </section> | |
| 744 | </div> | |
| 745 | </div> | |
| 5e1c08eb C |
746 | <div class="doc-row"> |
| 747 | <div class="doc-copy"> </div> | |
| 748 | <div class="doc-examples"></div> | |
| 749 | </div> | |
| 750 | <div class="doc-row"> | |
| 751 | <div class="doc-copy"> | |
| 752 | <section class="swagger-responses"> | |
| 753 | <div class="prop-row prop-group"> | |
| 754 | <div class="prop-name"> | |
| 755 | <div class="prop-title">200 OK</div> | |
| 756 | <div class="prop-ref"> | |
| 757 | <span class=""> | |
| 758 | <a class="json-schema-ref" href="#/definitions/ServerConfig">ServerConfig</a> | |
| 759 | </span> | |
| 760 | </div> | |
| 761 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 762 | </div> | |
| 763 | <div class="prop-value"> | |
| 764 | <p>successful operation</p> | |
| 765 | </div> | |
| 766 | </div> | |
| 767 | </section> | |
| 768 | </div> | |
| 769 | <div class="doc-examples"> | |
| 770 | <h5>Response Content-Types: | |
| 771 | <span>application/json</span> | |
| 772 | </h5> | |
| 773 | <section> | |
| 774 | <h5>Response Example | |
| 775 | <span>(200 OK)</span> | |
| 776 | </h5> | |
| 777 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 778 | <span class="hljs-attr">"signup"</span>: { | |
| 779 | <span class="hljs-attr">"allowed"</span>: <span class="hljs-string">"boolean"</span> | |
| 780 | }, | |
| 781 | <span class="hljs-attr">"transcoding"</span>: { | |
| 782 | <span class="hljs-attr">"enabledResolutions"</span>: [ | |
| 783 | <span class="hljs-string">"number"</span> | |
| 784 | ] | |
| 785 | }, | |
| 786 | <span class="hljs-attr">"avatar"</span>: { | |
| 787 | <span class="hljs-attr">"file"</span>: { | |
| 788 | <span class="hljs-attr">"size"</span>: { | |
| 789 | <span class="hljs-attr">"max"</span>: <span class="hljs-string">"number"</span> | |
| 790 | } | |
| 791 | }, | |
| 792 | <span class="hljs-attr">"extensions"</span>: [ | |
| 793 | <span class="hljs-string">"string"</span> | |
| 794 | ] | |
| 795 | }, | |
| 796 | <span class="hljs-attr">"video"</span>: { | |
| 797 | <span class="hljs-attr">"file"</span>: { | |
| 798 | <span class="hljs-attr">"extensions"</span>: [ | |
| 799 | <span class="hljs-string">"string"</span> | |
| 800 | ] | |
| 801 | } | |
| 802 | } | |
| 803 | } | |
| 804 | </code></pre> | |
| 805 | <!-- </div> --> | |
| 806 | </section> | |
| 807 | </div> | |
| 808 | </div> | |
| 809 | </div> | |
| 48dce1c9 | 810 | <h1 id="tag-Feeds" class="swagger-summary-tag" data-traverse-target="tag-Feeds">Feeds</h1> |
| 2963c343 RK |
811 | <div class="tag-description doc-row"> |
| 812 | <div class="doc-copy"> | |
| 813 | <p>Feeds of videos and feeds of comments allow to see updates and get them in an aggregator or script of your choice.</p> | |
| 814 | </div> | |
| 815 | </div> | |
| 48dce1c9 C |
816 | <div id="operation--feeds-videos.-format--get" class="operation panel" data-traverse-target="operation--feeds-videos.-format--get"> |
| 817 | <!-- <section class="operation-tags row"> --> | |
| 818 | <!-- <div class="doc-copy"> --> | |
| 819 | <div class="operation-tags"> | |
| 820 | <a class="label" href="#tag-Feeds">Feeds</a> | |
| 821 | <!----> | |
| 822 | </div> | |
| 823 | <!-- </div> --> | |
| 824 | <!-- </section> --> | |
| 825 | <h2 class="operation-title"> | |
| 2963c343 | 826 | <span class="operation-summary">Get the feed of videos for the server, with optional filter by account name or id</span> |
| 48dce1c9 | 827 | </h2> |
| 2963c343 RK |
828 | <div class="doc-row"> |
| 829 | <div class="doc-copy"> | |
| 830 | <section class="swagger-operation-path"> | |
| 831 | <span class="operation-method">GET</span> | |
| 832 | <span class="operation-path">/feeds/videos.{format}</span> | |
| 833 | </section> | |
| 834 | </div> | |
| 835 | </div> | |
| 48dce1c9 C |
836 | <div class="doc-row"> |
| 837 | <div class="doc-copy"> | |
| 838 | <section class="swagger-request-params"> | |
| 839 | <div class="prop-row prop-group"> | |
| 840 | <div class="prop-name"> | |
| 330eaf12 C |
841 | <div class="prop-title">format: |
| 842 | <span class="prop-type"> | |
| 843 | <span class="json-property-type">string</span> | |
| 844 | <span class="json-property-enum" title="Possible values"> | |
| 845 | <span class="json-property-enum-item json-property-enum-default-value">xml</span>, | |
| 846 | <span class="json-property-enum-item">atom</span>, | |
| 847 | <span class="json-property-enum-item">json</span> | |
| 848 | </span> | |
| 849 | <span class="json-property-range" title="Value limits"></span> | |
| 850 | <span class="json-property-default-value" title="Default value">xml</span> | |
| 48dce1c9 | 851 | </span> |
| 48dce1c9 | 852 | </div> |
| 330eaf12 C |
853 | <span class="json-property-required"></span> |
| 854 | <div class="prop-subtitle"> in path </div> | |
| 48dce1c9 C |
855 | </div> |
| 856 | <div class="prop-value"> | |
| 857 | <p>The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and json to JSON FEED 1.0</p> | |
| 858 | </div> | |
| 859 | </div> | |
| 860 | <div class="prop-row prop-group"> | |
| 861 | <div class="prop-name"> | |
| 330eaf12 C |
862 | <div class="prop-title">accountId: |
| 863 | <span class="prop-type"> | |
| 864 | <span class="json-property-type">number</span> | |
| 865 | <span class="json-property-range" title="Value limits"></span> | |
| 866 | </span> | |
| 48dce1c9 | 867 | </div> |
| 330eaf12 | 868 | <div class="prop-subtitle"> in query </div> |
| 48dce1c9 C |
869 | </div> |
| 870 | <div class="prop-value"> | |
| 871 | <p>The id of the local account to filter to (beware, users IDs and not actors IDs which will return empty feeds</p> | |
| 872 | </div> | |
| 873 | </div> | |
| 874 | <div class="prop-row prop-group"> | |
| 875 | <div class="prop-name"> | |
| 330eaf12 C |
876 | <div class="prop-title">accountName: |
| 877 | <span class="prop-type"> | |
| 878 | <span class="json-property-type">string</span> | |
| 879 | <span class="json-property-range" title="Value limits"></span> | |
| 880 | </span> | |
| 48dce1c9 | 881 | </div> |
| 330eaf12 | 882 | <div class="prop-subtitle"> in query </div> |
| 48dce1c9 C |
883 | </div> |
| 884 | <div class="prop-value"> | |
| 885 | <p>The name of the local account to filter to</p> | |
| 886 | </div> | |
| 887 | </div> | |
| 888 | </section> | |
| 889 | </div> | |
| 890 | <div class="doc-examples"></div> | |
| 891 | </div> | |
| 892 | <div class="doc-row"> | |
| 893 | <div class="doc-copy"> | |
| 894 | <section class="swagger-responses"> | |
| 895 | <div class="prop-row prop-group"> | |
| 896 | <div class="prop-name"> | |
| 897 | <div class="prop-title">200 OK</div> | |
| 898 | </div> | |
| 899 | <div class="prop-value"> | |
| 900 | <p>successful operation</p> | |
| 901 | </div> | |
| 902 | </div> | |
| 903 | </section> | |
| 904 | </div> | |
| 905 | <div class="doc-examples"> | |
| 906 | <h5>Response Content-Types: | |
| 907 | <span>application/atom+xml, application/rss+xml, application/json</span> | |
| 908 | </h5> | |
| 909 | </div> | |
| 910 | </div> | |
| 911 | </div> | |
| 5e1c08eb | 912 | <h1 id="tag-Job" class="swagger-summary-tag" data-traverse-target="tag-Job">Job</h1> |
| 2963c343 RK |
913 | <div class="tag-description doc-row"> |
| 914 | <div class="doc-copy"> | |
| 915 | <p>Jobs are long-running tasks enqueued and processed by the instance itself. No additional worker registration is currently available.</p> | |
| 916 | </div> | |
| 917 | </div> | |
| 5e1c08eb C |
918 | <div id="operation--jobs-get" class="operation panel" data-traverse-target="operation--jobs-get"> |
| 919 | <!-- <section class="operation-tags row"> --> | |
| 920 | <!-- <div class="doc-copy"> --> | |
| 921 | <div class="operation-tags"> | |
| 922 | <a class="label" href="#tag-Job">Job</a> | |
| 923 | <!----> | |
| 924 | </div> | |
| 925 | <!-- </div> --> | |
| 926 | <!-- </section> --> | |
| 927 | <h2 class="operation-title"> | |
| 2963c343 | 928 | <span class="operation-summary">Get list of jobs</span> |
| 5e1c08eb | 929 | </h2> |
| 2963c343 RK |
930 | <div class="doc-row"> |
| 931 | <div class="doc-copy"> | |
| 932 | <section class="swagger-operation-path"> | |
| 933 | <span class="operation-method">GET</span> | |
| 934 | <span class="operation-path">/jobs</span> | |
| 935 | </section> | |
| 936 | </div> | |
| 937 | </div> | |
| 5e1c08eb | 938 | <div class="doc-row"> |
| ab0ee6a1 C |
939 | <div class="doc-copy"> |
| 940 | <section class="swagger-request-params"> | |
| 941 | <div class="prop-row prop-group"> | |
| 942 | <div class="prop-name"> | |
| 330eaf12 C |
943 | <div class="prop-title">state: |
| 944 | <span class="prop-type"> | |
| 945 | <span class="json-property-type">string</span> | |
| 946 | <span class="json-property-range" title="Value limits"></span> | |
| 947 | </span> | |
| 948 | </div> | |
| ab0ee6a1 | 949 | <span class="json-property-required"></span> |
| 228e84aa | 950 | <div class="prop-subtitle"> in path </div> |
| ab0ee6a1 C |
951 | </div> |
| 952 | <div class="prop-value"> | |
| 330eaf12 | 953 | <p>The state of the job</p> |
| ab0ee6a1 C |
954 | </div> |
| 955 | </div> | |
| ab0ee6a1 C |
956 | <div class="prop-row prop-group"> |
| 957 | <div class="prop-name"> | |
| 330eaf12 C |
958 | <div class="prop-title">start: |
| 959 | <span class="prop-type"> | |
| 960 | <span class="json-property-type">number</span> | |
| 961 | <span class="json-property-range" title="Value limits"></span> | |
| 962 | </span> | |
| 228e84aa | 963 | </div> |
| 330eaf12 | 964 | <div class="prop-subtitle"> in query </div> |
| ab0ee6a1 C |
965 | </div> |
| 966 | <div class="prop-value"> | |
| 330eaf12 | 967 | <p>Offset</p> |
| ab0ee6a1 C |
968 | </div> |
| 969 | </div> | |
| ab0ee6a1 C |
970 | <div class="prop-row prop-group"> |
| 971 | <div class="prop-name"> | |
| 330eaf12 C |
972 | <div class="prop-title">count: |
| 973 | <span class="prop-type"> | |
| 974 | <span class="json-property-type">number</span> | |
| 975 | <span class="json-property-range" title="Value limits"></span> | |
| 976 | </span> | |
| 228e84aa | 977 | </div> |
| 330eaf12 | 978 | <div class="prop-subtitle"> in query </div> |
| ab0ee6a1 C |
979 | </div> |
| 980 | <div class="prop-value"> | |
| 330eaf12 | 981 | <p>Number of items</p> |
| ab0ee6a1 C |
982 | </div> |
| 983 | </div> | |
| ab0ee6a1 C |
984 | <div class="prop-row prop-group"> |
| 985 | <div class="prop-name"> | |
| 330eaf12 C |
986 | <div class="prop-title">sort: |
| 987 | <span class="prop-type"> | |
| 988 | <span class="json-property-type">string</span> | |
| 989 | <span class="json-property-range" title="Value limits"></span> | |
| 990 | </span> | |
| 228e84aa | 991 | </div> |
| 330eaf12 | 992 | <div class="prop-subtitle"> in query </div> |
| ab0ee6a1 C |
993 | </div> |
| 994 | <div class="prop-value"> | |
| 330eaf12 | 995 | <p>Sort column (-createdAt for example)</p> |
| ab0ee6a1 C |
996 | </div> |
| 997 | </div> | |
| ab0ee6a1 C |
998 | </section> |
| 999 | </div> | |
| 5e1c08eb C |
1000 | <div class="doc-examples"></div> |
| 1001 | </div> | |
| 1002 | <div class="doc-row"> | |
| 1003 | <div class="doc-copy"> | |
| 1004 | <section class="swagger-responses"> | |
| 1005 | <div class="prop-row prop-group"> | |
| 1006 | <div class="prop-name"> | |
| 1007 | <div class="prop-title">200 OK</div> | |
| 1008 | <div class="prop-ref"> | |
| 1009 | <span class="json-schema-ref-array"> | |
| 1010 | <a class="json-schema-ref" href="#/definitions/Job">Job</a> | |
| 1011 | </span> | |
| 1012 | </div> | |
| 1013 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 1014 | </div> | |
| 1015 | <div class="prop-value"> | |
| 1016 | <p>successful operation</p> | |
| 1017 | </div> | |
| 1018 | </div> | |
| 228e84aa C |
1019 | <div class="prop-row prop-inner"> |
| 1020 | <div class="prop-name">type</div> | |
| 1021 | <div class="prop-value"> | |
| 1022 | <span class="json-property-type"> | |
| 1023 | <span class="json-schema-ref-array"> | |
| 1024 | <a class="json-schema-ref" href="#/definitions/Job">Job</a> | |
| 1025 | </span> | |
| 1026 | </span> | |
| 1027 | <span class="json-property-range" title="Value limits"></span> | |
| 1028 | </div> | |
| 1029 | </div> | |
| 5e1c08eb C |
1030 | </section> |
| 1031 | </div> | |
| 1032 | <div class="doc-examples"> | |
| 1033 | <h5>Response Content-Types: | |
| 1034 | <span>application/json</span> | |
| 1035 | </h5> | |
| 1036 | <section> | |
| 1037 | <h5>Response Example | |
| 1038 | <span>(200 OK)</span> | |
| 1039 | </h5> | |
| 1040 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 1041 | { | |
| 1042 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1043 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
| 1044 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"string"</span>, | |
| 1045 | <span class="hljs-attr">"handlerName"</span>: <span class="hljs-string">"string"</span>, | |
| 1046 | <span class="hljs-attr">"handlerInputData"</span>: <span class="hljs-string">"string"</span>, | |
| 1047 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1048 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1049 | } | |
| 1050 | ] | |
| 1051 | </code></pre> | |
| 1052 | <!-- </div> --> | |
| 1053 | </section> | |
| 1054 | </div> | |
| 1055 | </div> | |
| 94ff4c23 C |
1056 | <div class="doc-row"> |
| 1057 | <div class="doc-copy"> | |
| 1058 | <section class="swagger-request-security"> | |
| 1059 | <table class="table"> | |
| 1060 | <thead> | |
| 1061 | <tr> | |
| 1062 | <th class="swagger-request-security-schema"></th> | |
| 1063 | <th class="swagger-request-security-scopes"></th> | |
| 1064 | </tr> | |
| 1065 | </thead> | |
| 1066 | <tbody> | |
| 1067 | <tr> | |
| 1068 | <td> | |
| 1069 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 1070 | </td> | |
| 2963c343 RK |
1071 | <td> |
| 1072 | <a href="#security-definition-scope-admin">admin</a> | |
| 1073 | </td> | |
| 94ff4c23 C |
1074 | </tr> |
| 1075 | </tbody> | |
| 1076 | </table> | |
| 1077 | </section> | |
| 1078 | </div> | |
| 1079 | </div> | |
| 5e1c08eb C |
1080 | </div> |
| 1081 | <h1 id="tag-ServerFollowing" class="swagger-summary-tag" data-traverse-target="tag-ServerFollowing">ServerFollowing</h1> | |
| 2963c343 RK |
1082 | <div class="tag-description doc-row"> |
| 1083 | <div class="doc-copy"> | |
| 1084 | <p>Managing servers which the instance interacts with is crucial to the concept of federation in PeerTube and external video indexation. The PeerTube server then deals with inter-server ActivityPub operations and propagates information across its social graph by posting activities to actors' inbox endpoints.</p> | |
| 1085 | </div> | |
| 1086 | </div> | |
| 5e1c08eb C |
1087 | <div id="operation--server-following--host--delete" class="operation panel" data-traverse-target="operation--server-following--host--delete"> |
| 1088 | <!-- <section class="operation-tags row"> --> | |
| 1089 | <!-- <div class="doc-copy"> --> | |
| 1090 | <div class="operation-tags"> | |
| 1091 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
| 1092 | <!----> | |
| 1093 | </div> | |
| 1094 | <!-- </div> --> | |
| 1095 | <!-- </section> --> | |
| 1096 | <h2 class="operation-title"> | |
| 2963c343 | 1097 | <span class="operation-summary">Unfollow a server by hostname</span> |
| 5e1c08eb | 1098 | </h2> |
| 2963c343 RK |
1099 | <div class="doc-row"> |
| 1100 | <div class="doc-copy"> | |
| 1101 | <section class="swagger-operation-path"> | |
| 1102 | <span class="operation-method">DELETE</span> | |
| 1103 | <span class="operation-path">/server/following/{host}</span> | |
| 1104 | </section> | |
| 1105 | </div> | |
| 1106 | </div> | |
| 5e1c08eb C |
1107 | <div class="doc-row"> |
| 1108 | <div class="doc-copy"> | |
| 1109 | <section class="swagger-request-params"> | |
| 1110 | <div class="prop-row prop-group"> | |
| 1111 | <div class="prop-name"> | |
| 330eaf12 C |
1112 | <div class="prop-title">host: |
| 1113 | <span class="prop-type"> | |
| 1114 | <span class="json-property-type">string</span> | |
| 1115 | <span class="json-property-range" title="Value limits"></span> | |
| 1116 | </span> | |
| 1117 | </div> | |
| 5e1c08eb | 1118 | <span class="json-property-required"></span> |
| 228e84aa | 1119 | <div class="prop-subtitle"> in path </div> |
| 5e1c08eb C |
1120 | </div> |
| 1121 | <div class="prop-value"> | |
| 1122 | <p>The host to unfollow </p> | |
| 1123 | </div> | |
| 1124 | </div> | |
| 5e1c08eb C |
1125 | </section> |
| 1126 | </div> | |
| 1127 | <div class="doc-examples"></div> | |
| 1128 | </div> | |
| 1129 | <div class="doc-row"> | |
| 1130 | <div class="doc-copy"> | |
| 1131 | <section class="swagger-responses"> | |
| 1132 | <div class="prop-row prop-group"> | |
| 1133 | <div class="prop-name"> | |
| 1134 | <div class="prop-title">201 Created</div> | |
| 1135 | </div> | |
| 1136 | <div class="prop-value"> | |
| 1137 | <p>successful operation</p> | |
| 1138 | </div> | |
| 1139 | </div> | |
| 1140 | </section> | |
| 1141 | </div> | |
| 1142 | <div class="doc-examples"> | |
| 1143 | <h5>Response Content-Types: | |
| 1144 | <span>application/json</span> | |
| 1145 | </h5> | |
| 1146 | </div> | |
| 1147 | </div> | |
| 94ff4c23 C |
1148 | <div class="doc-row"> |
| 1149 | <div class="doc-copy"> | |
| 1150 | <section class="swagger-request-security"> | |
| 1151 | <table class="table"> | |
| 1152 | <thead> | |
| 1153 | <tr> | |
| 1154 | <th class="swagger-request-security-schema"></th> | |
| 1155 | <th class="swagger-request-security-scopes"></th> | |
| 1156 | </tr> | |
| 1157 | </thead> | |
| 1158 | <tbody> | |
| 1159 | <tr> | |
| 1160 | <td> | |
| 1161 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 1162 | </td> | |
| 2963c343 RK |
1163 | <td> |
| 1164 | <a href="#security-definition-scope-admin">admin</a> | |
| 1165 | </td> | |
| 94ff4c23 C |
1166 | </tr> |
| 1167 | </tbody> | |
| 1168 | </table> | |
| 1169 | </section> | |
| 1170 | </div> | |
| 1171 | </div> | |
| 5e1c08eb C |
1172 | </div> |
| 1173 | <div id="operation--server-followers-get" class="operation panel" data-traverse-target="operation--server-followers-get"> | |
| 1174 | <!-- <section class="operation-tags row"> --> | |
| 1175 | <!-- <div class="doc-copy"> --> | |
| 1176 | <div class="operation-tags"> | |
| 1177 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
| 1178 | <!----> | |
| 1179 | </div> | |
| 1180 | <!-- </div> --> | |
| 1181 | <!-- </section> --> | |
| 1182 | <h2 class="operation-title"> | |
| 2963c343 | 1183 | <span class="operation-summary">Get followers of the server</span> |
| 5e1c08eb | 1184 | </h2> |
| 2963c343 RK |
1185 | <div class="doc-row"> |
| 1186 | <div class="doc-copy"> | |
| 1187 | <section class="swagger-operation-path"> | |
| 1188 | <span class="operation-method">GET</span> | |
| 1189 | <span class="operation-path">/server/followers</span> | |
| 1190 | </section> | |
| 1191 | </div> | |
| 1192 | </div> | |
| 5e1c08eb | 1193 | <div class="doc-row"> |
| ab0ee6a1 C |
1194 | <div class="doc-copy"> |
| 1195 | <section class="swagger-request-params"> | |
| 1196 | <div class="prop-row prop-group"> | |
| 1197 | <div class="prop-name"> | |
| 330eaf12 C |
1198 | <div class="prop-title">start: |
| 1199 | <span class="prop-type"> | |
| 1200 | <span class="json-property-type">number</span> | |
| 1201 | <span class="json-property-range" title="Value limits"></span> | |
| 1202 | </span> | |
| 228e84aa | 1203 | </div> |
| 330eaf12 | 1204 | <div class="prop-subtitle"> in query </div> |
| ab0ee6a1 C |
1205 | </div> |
| 1206 | <div class="prop-value"> | |
| 330eaf12 | 1207 | <p>Offset</p> |
| ab0ee6a1 C |
1208 | </div> |
| 1209 | </div> | |
| ab0ee6a1 C |
1210 | <div class="prop-row prop-group"> |
| 1211 | <div class="prop-name"> | |
| 330eaf12 C |
1212 | <div class="prop-title">count: |
| 1213 | <span class="prop-type"> | |
| 1214 | <span class="json-property-type">number</span> | |
| 1215 | <span class="json-property-range" title="Value limits"></span> | |
| 1216 | </span> | |
| 228e84aa | 1217 | </div> |
| 330eaf12 | 1218 | <div class="prop-subtitle"> in query </div> |
| ab0ee6a1 C |
1219 | </div> |
| 1220 | <div class="prop-value"> | |
| 330eaf12 | 1221 | <p>Number of items</p> |
| ab0ee6a1 C |
1222 | </div> |
| 1223 | </div> | |
| ab0ee6a1 C |
1224 | <div class="prop-row prop-group"> |
| 1225 | <div class="prop-name"> | |
| 330eaf12 C |
1226 | <div class="prop-title">sort: |
| 1227 | <span class="prop-type"> | |
| 1228 | <span class="json-property-type">string</span> | |
| 1229 | <span class="json-property-range" title="Value limits"></span> | |
| 1230 | </span> | |
| 228e84aa | 1231 | </div> |
| 330eaf12 | 1232 | <div class="prop-subtitle"> in query </div> |
| ab0ee6a1 C |
1233 | </div> |
| 1234 | <div class="prop-value"> | |
| 330eaf12 | 1235 | <p>Sort column (-createdAt for example)</p> |
| ab0ee6a1 C |
1236 | </div> |
| 1237 | </div> | |
| ab0ee6a1 C |
1238 | </section> |
| 1239 | </div> | |
| 5e1c08eb C |
1240 | <div class="doc-examples"></div> |
| 1241 | </div> | |
| 1242 | <div class="doc-row"> | |
| 1243 | <div class="doc-copy"> | |
| 1244 | <section class="swagger-responses"> | |
| 1245 | <div class="prop-row prop-group"> | |
| 1246 | <div class="prop-name"> | |
| 1247 | <div class="prop-title">200 OK</div> | |
| 1248 | <div class="prop-ref"> | |
| 1249 | <span class="json-schema-ref-array"> | |
| 1250 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
| 1251 | </span> | |
| 1252 | </div> | |
| 1253 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 1254 | </div> | |
| 1255 | <div class="prop-value"> | |
| 1256 | <p>successful operation</p> | |
| 1257 | </div> | |
| 1258 | </div> | |
| 228e84aa C |
1259 | <div class="prop-row prop-inner"> |
| 1260 | <div class="prop-name">type</div> | |
| 1261 | <div class="prop-value"> | |
| 1262 | <span class="json-property-type"> | |
| 1263 | <span class="json-schema-ref-array"> | |
| 1264 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
| 1265 | </span> | |
| 1266 | </span> | |
| 1267 | <span class="json-property-range" title="Value limits"></span> | |
| 1268 | </div> | |
| 1269 | </div> | |
| 5e1c08eb C |
1270 | </section> |
| 1271 | </div> | |
| 1272 | <div class="doc-examples"> | |
| 1273 | <h5>Response Content-Types: | |
| 1274 | <span>application/json</span> | |
| 1275 | </h5> | |
| 1276 | <section> | |
| 1277 | <h5>Response Example | |
| 1278 | <span>(200 OK)</span> | |
| 1279 | </h5> | |
| 1280 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 1281 | { | |
| 1282 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1283 | <span class="hljs-attr">"follower"</span>: { | |
| 1284 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1285 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 1286 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 1287 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 1288 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 1289 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1290 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1291 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1292 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1293 | <span class="hljs-attr">"avatar"</span>: { | |
| 1294 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 1295 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1296 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1297 | } | |
| 1298 | }, | |
| 1299 | <span class="hljs-attr">"following"</span>: { | |
| 1300 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1301 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 1302 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 1303 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 1304 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 1305 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1306 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1307 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1308 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1309 | <span class="hljs-attr">"avatar"</span>: { | |
| 1310 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 1311 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1312 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1313 | } | |
| 1314 | }, | |
| 1315 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
| 1316 | <span class="hljs-attr">"state"</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 | </code></pre> | |
| 1322 | <!-- </div> --> | |
| 1323 | </section> | |
| 1324 | </div> | |
| 1325 | </div> | |
| 1326 | </div> | |
| 1327 | <div id="operation--server-following-get" class="operation panel" data-traverse-target="operation--server-following-get"> | |
| 1328 | <!-- <section class="operation-tags row"> --> | |
| 1329 | <!-- <div class="doc-copy"> --> | |
| 1330 | <div class="operation-tags"> | |
| 1331 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
| 1332 | <!----> | |
| 1333 | </div> | |
| 1334 | <!-- </div> --> | |
| 1335 | <!-- </section> --> | |
| 1336 | <h2 class="operation-title"> | |
| 2963c343 | 1337 | <span class="operation-summary">Get servers followed by the server</span> |
| 5e1c08eb | 1338 | </h2> |
| 2963c343 RK |
1339 | <div class="doc-row"> |
| 1340 | <div class="doc-copy"> | |
| 1341 | <section class="swagger-operation-path"> | |
| 1342 | <span class="operation-method">GET</span> | |
| 1343 | <span class="operation-path">/server/following</span> | |
| 1344 | </section> | |
| 1345 | </div> | |
| 1346 | </div> | |
| 5e1c08eb | 1347 | <div class="doc-row"> |
| ab0ee6a1 C |
1348 | <div class="doc-copy"> |
| 1349 | <section class="swagger-request-params"> | |
| 1350 | <div class="prop-row prop-group"> | |
| 1351 | <div class="prop-name"> | |
| 330eaf12 C |
1352 | <div class="prop-title">start: |
| 1353 | <span class="prop-type"> | |
| 1354 | <span class="json-property-type">number</span> | |
| 1355 | <span class="json-property-range" title="Value limits"></span> | |
| 1356 | </span> | |
| 228e84aa | 1357 | </div> |
| 330eaf12 | 1358 | <div class="prop-subtitle"> in query </div> |
| ab0ee6a1 C |
1359 | </div> |
| 1360 | <div class="prop-value"> | |
| 330eaf12 | 1361 | <p>Offset</p> |
| ab0ee6a1 C |
1362 | </div> |
| 1363 | </div> | |
| ab0ee6a1 C |
1364 | <div class="prop-row prop-group"> |
| 1365 | <div class="prop-name"> | |
| 330eaf12 C |
1366 | <div class="prop-title">count: |
| 1367 | <span class="prop-type"> | |
| 1368 | <span class="json-property-type">number</span> | |
| 1369 | <span class="json-property-range" title="Value limits"></span> | |
| 1370 | </span> | |
| 228e84aa | 1371 | </div> |
| 330eaf12 | 1372 | <div class="prop-subtitle"> in query </div> |
| ab0ee6a1 C |
1373 | </div> |
| 1374 | <div class="prop-value"> | |
| 330eaf12 | 1375 | <p>Number of items</p> |
| ab0ee6a1 C |
1376 | </div> |
| 1377 | </div> | |
| ab0ee6a1 C |
1378 | <div class="prop-row prop-group"> |
| 1379 | <div class="prop-name"> | |
| 330eaf12 C |
1380 | <div class="prop-title">sort: |
| 1381 | <span class="prop-type"> | |
| 1382 | <span class="json-property-type">string</span> | |
| 1383 | <span class="json-property-range" title="Value limits"></span> | |
| 1384 | </span> | |
| 228e84aa | 1385 | </div> |
| 330eaf12 | 1386 | <div class="prop-subtitle"> in query </div> |
| ab0ee6a1 C |
1387 | </div> |
| 1388 | <div class="prop-value"> | |
| 330eaf12 | 1389 | <p>Sort column (-createdAt for example)</p> |
| ab0ee6a1 C |
1390 | </div> |
| 1391 | </div> | |
| ab0ee6a1 C |
1392 | </section> |
| 1393 | </div> | |
| 5e1c08eb C |
1394 | <div class="doc-examples"></div> |
| 1395 | </div> | |
| 1396 | <div class="doc-row"> | |
| 1397 | <div class="doc-copy"> | |
| 1398 | <section class="swagger-responses"> | |
| 1399 | <div class="prop-row prop-group"> | |
| 1400 | <div class="prop-name"> | |
| 1401 | <div class="prop-title">200 OK</div> | |
| 1402 | <div class="prop-ref"> | |
| 1403 | <span class="json-schema-ref-array"> | |
| 1404 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
| 1405 | </span> | |
| 1406 | </div> | |
| 1407 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 1408 | </div> | |
| 1409 | <div class="prop-value"> | |
| 1410 | <p>successful operation</p> | |
| 1411 | </div> | |
| 1412 | </div> | |
| 228e84aa C |
1413 | <div class="prop-row prop-inner"> |
| 1414 | <div class="prop-name">type</div> | |
| 1415 | <div class="prop-value"> | |
| 1416 | <span class="json-property-type"> | |
| 1417 | <span class="json-schema-ref-array"> | |
| 1418 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
| 1419 | </span> | |
| 1420 | </span> | |
| 1421 | <span class="json-property-range" title="Value limits"></span> | |
| 1422 | </div> | |
| 1423 | </div> | |
| 5e1c08eb C |
1424 | </section> |
| 1425 | </div> | |
| 1426 | <div class="doc-examples"> | |
| 1427 | <h5>Response Content-Types: | |
| 1428 | <span>application/json</span> | |
| 1429 | </h5> | |
| 1430 | <section> | |
| 1431 | <h5>Response Example | |
| 1432 | <span>(200 OK)</span> | |
| 1433 | </h5> | |
| 1434 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 1435 | { | |
| 1436 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1437 | <span class="hljs-attr">"follower"</span>: { | |
| 1438 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1439 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 1440 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 1441 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 1442 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 1443 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1444 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1445 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1446 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1447 | <span class="hljs-attr">"avatar"</span>: { | |
| 1448 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 1449 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1450 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1451 | } | |
| 1452 | }, | |
| 1453 | <span class="hljs-attr">"following"</span>: { | |
| 1454 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1455 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 1456 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 1457 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 1458 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 1459 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1460 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1461 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1462 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1463 | <span class="hljs-attr">"avatar"</span>: { | |
| 1464 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 1465 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1466 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1467 | } | |
| 1468 | }, | |
| 1469 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
| 1470 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
| 1471 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1472 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1473 | } | |
| 1474 | ] | |
| 1475 | </code></pre> | |
| 1476 | <!-- </div> --> | |
| 1477 | </section> | |
| 1478 | </div> | |
| 1479 | </div> | |
| 1480 | </div> | |
| 1481 | <div id="operation--server-following-post" class="operation panel" data-traverse-target="operation--server-following-post"> | |
| 1482 | <!-- <section class="operation-tags row"> --> | |
| 1483 | <!-- <div class="doc-copy"> --> | |
| 1484 | <div class="operation-tags"> | |
| 1485 | <a class="label" href="#tag-ServerFollowing">ServerFollowing</a> | |
| 1486 | <!----> | |
| 1487 | </div> | |
| 1488 | <!-- </div> --> | |
| 1489 | <!-- </section> --> | |
| 1490 | <h2 class="operation-title"> | |
| 2963c343 | 1491 | <span class="operation-summary">Follow a server</span> |
| 5e1c08eb | 1492 | </h2> |
| 2963c343 RK |
1493 | <div class="doc-row"> |
| 1494 | <div class="doc-copy"> | |
| 1495 | <section class="swagger-operation-path"> | |
| 1496 | <span class="operation-method">POST</span> | |
| 1497 | <span class="operation-path">/server/following</span> | |
| 1498 | </section> | |
| 1499 | </div> | |
| 1500 | </div> | |
| 5e1c08eb C |
1501 | <div class="doc-row"> |
| 1502 | <div class="doc-copy"> | |
| 1503 | <section class="swagger-request-body"> | |
| 1504 | <div class="prop-row"> | |
| 1505 | <div class="prop-name"> | |
| 1506 | <div class="swagger-request-model"> | |
| 1507 | <span class=""> | |
| 1508 | <a class="json-schema-ref" href="#/definitions/Follow">Follow</a> | |
| 1509 | </span> | |
| 1510 | </div> | |
| 1511 | </div> | |
| 1512 | <div class="prop-value columns small-6"> | |
| 228e84aa C |
1513 | <!-- <div class="swagger-request-description"> --> |
| 1514 | <p>undefined</p> | |
| 5e1c08eb C |
1515 | <!-- </div> --> |
| 1516 | </div> | |
| 1517 | </div> | |
| 1518 | </section> | |
| 1519 | </div> | |
| 1520 | <div class="doc-examples"> | |
| 1521 | <section> | |
| 1522 | <h5>Request Content-Types: | |
| 1523 | <span>application/json</span> | |
| 1524 | </h5> | |
| 1525 | <h5>Request Example</h5> | |
| 1526 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 1527 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1528 | <span class="hljs-attr">"follower"</span>: { | |
| 1529 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1530 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 1531 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 1532 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 1533 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 1534 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1535 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1536 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1537 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1538 | <span class="hljs-attr">"avatar"</span>: { | |
| 1539 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 1540 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1541 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1542 | } | |
| 1543 | }, | |
| 1544 | <span class="hljs-attr">"following"</span>: { | |
| 1545 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1546 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 1547 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 1548 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 1549 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 1550 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1551 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1552 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1553 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1554 | <span class="hljs-attr">"avatar"</span>: { | |
| 1555 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 1556 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1557 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1558 | } | |
| 1559 | }, | |
| 1560 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
| 1561 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
| 1562 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1563 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1564 | } | |
| 1565 | </code></pre> | |
| 1566 | <!-- </div> --> | |
| 1567 | </section> | |
| 1568 | </div> | |
| 1569 | </div> | |
| 1570 | <div class="doc-row"> | |
| 1571 | <div class="doc-copy"> | |
| 1572 | <section class="swagger-responses"> | |
| 1573 | <div class="prop-row prop-group"> | |
| 1574 | <div class="prop-name"> | |
| 1575 | <div class="prop-title">204 No Content</div> | |
| 1576 | </div> | |
| 1577 | <div class="prop-value"> | |
| 330eaf12 | 1578 | <p>Successful operation</p> |
| 5e1c08eb C |
1579 | </div> |
| 1580 | </div> | |
| 1581 | </section> | |
| 1582 | </div> | |
| 1583 | <div class="doc-examples"> | |
| 1584 | <h5>Response Content-Types: | |
| 1585 | <span>application/json</span> | |
| 1586 | </h5> | |
| 1587 | </div> | |
| 1588 | </div> | |
| 94ff4c23 C |
1589 | <div class="doc-row"> |
| 1590 | <div class="doc-copy"> | |
| 1591 | <section class="swagger-request-security"> | |
| 1592 | <table class="table"> | |
| 1593 | <thead> | |
| 1594 | <tr> | |
| 1595 | <th class="swagger-request-security-schema"></th> | |
| 1596 | <th class="swagger-request-security-scopes"></th> | |
| 1597 | </tr> | |
| 1598 | </thead> | |
| 1599 | <tbody> | |
| 1600 | <tr> | |
| 1601 | <td> | |
| 1602 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 1603 | </td> | |
| 2963c343 RK |
1604 | <td> |
| 1605 | <a href="#security-definition-scope-admin">admin</a> | |
| 1606 | </td> | |
| 94ff4c23 C |
1607 | </tr> |
| 1608 | </tbody> | |
| 1609 | </table> | |
| 1610 | </section> | |
| 1611 | </div> | |
| 1612 | </div> | |
| 5e1c08eb | 1613 | </div> |
| 2963c343 RK |
1614 | <h1 id="tag-VideoAbuse" class="swagger-summary-tag" data-traverse-target="tag-VideoAbuse">VideoAbuse</h1> |
| 1615 | <div class="tag-description doc-row"> | |
| 1616 | <div class="doc-copy"> | |
| 1617 | <p>Video abuses deal with reports of local or remote videos alike.</p> | |
| 1618 | </div> | |
| 1619 | </div> | |
| 1620 | <div id="operation--videos-abuse-get" class="operation panel" data-traverse-target="operation--videos-abuse-get"> | |
| 5e1c08eb C |
1621 | <!-- <section class="operation-tags row"> --> |
| 1622 | <!-- <div class="doc-copy"> --> | |
| 1623 | <div class="operation-tags"> | |
| 2963c343 | 1624 | <a class="label" href="#tag-VideoAbuse">VideoAbuse</a> |
| 5e1c08eb C |
1625 | <!----> |
| 1626 | </div> | |
| 1627 | <!-- </div> --> | |
| 1628 | <!-- </section> --> | |
| 1629 | <h2 class="operation-title"> | |
| 2963c343 | 1630 | <span class="operation-summary">Get list of reported video abuses</span> |
| 5e1c08eb C |
1631 | </h2> |
| 1632 | <div class="doc-row"> | |
| 1633 | <div class="doc-copy"> | |
| 2963c343 RK |
1634 | <section class="swagger-operation-path"> |
| 1635 | <span class="operation-method">GET</span> | |
| 1636 | <span class="operation-path">/videos/abuse</span> | |
| 94ff4c23 C |
1637 | </section> |
| 1638 | </div> | |
| 1639 | </div> | |
| 5e1c08eb | 1640 | <div class="doc-row"> |
| ab0ee6a1 C |
1641 | <div class="doc-copy"> |
| 1642 | <section class="swagger-request-params"> | |
| 1643 | <div class="prop-row prop-group"> | |
| 1644 | <div class="prop-name"> | |
| 330eaf12 C |
1645 | <div class="prop-title">start: |
| 1646 | <span class="prop-type"> | |
| 1647 | <span class="json-property-type">number</span> | |
| 1648 | <span class="json-property-range" title="Value limits"></span> | |
| 1649 | </span> | |
| 228e84aa | 1650 | </div> |
| 330eaf12 | 1651 | <div class="prop-subtitle"> in query </div> |
| ab0ee6a1 C |
1652 | </div> |
| 1653 | <div class="prop-value"> | |
| 330eaf12 | 1654 | <p>Offset</p> |
| ab0ee6a1 C |
1655 | </div> |
| 1656 | </div> | |
| ab0ee6a1 C |
1657 | <div class="prop-row prop-group"> |
| 1658 | <div class="prop-name"> | |
| 330eaf12 C |
1659 | <div class="prop-title">count: |
| 1660 | <span class="prop-type"> | |
| 1661 | <span class="json-property-type">number</span> | |
| 1662 | <span class="json-property-range" title="Value limits"></span> | |
| 1663 | </span> | |
| 228e84aa | 1664 | </div> |
| 330eaf12 | 1665 | <div class="prop-subtitle"> in query </div> |
| ab0ee6a1 C |
1666 | </div> |
| 1667 | <div class="prop-value"> | |
| 330eaf12 | 1668 | <p>Number of items</p> |
| ab0ee6a1 C |
1669 | </div> |
| 1670 | </div> | |
| ab0ee6a1 C |
1671 | <div class="prop-row prop-group"> |
| 1672 | <div class="prop-name"> | |
| 330eaf12 C |
1673 | <div class="prop-title">sort: |
| 1674 | <span class="prop-type"> | |
| 1675 | <span class="json-property-type">string</span> | |
| 1676 | <span class="json-property-range" title="Value limits"></span> | |
| 1677 | </span> | |
| 228e84aa | 1678 | </div> |
| 330eaf12 | 1679 | <div class="prop-subtitle"> in query </div> |
| ab0ee6a1 C |
1680 | </div> |
| 1681 | <div class="prop-value"> | |
| 330eaf12 | 1682 | <p>Sort column (-createdAt for example)</p> |
| ab0ee6a1 C |
1683 | </div> |
| 1684 | </div> | |
| ab0ee6a1 C |
1685 | </section> |
| 1686 | </div> | |
| 5e1c08eb C |
1687 | <div class="doc-examples"></div> |
| 1688 | </div> | |
| 1689 | <div class="doc-row"> | |
| 1690 | <div class="doc-copy"> | |
| 1691 | <section class="swagger-responses"> | |
| 1692 | <div class="prop-row prop-group"> | |
| 1693 | <div class="prop-name"> | |
| 1694 | <div class="prop-title">200 OK</div> | |
| 1695 | <div class="prop-ref"> | |
| 1696 | <span class="json-schema-ref-array"> | |
| 2963c343 | 1697 | <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a> |
| 5e1c08eb C |
1698 | </span> |
| 1699 | </div> | |
| 1700 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 1701 | </div> | |
| 1702 | <div class="prop-value"> | |
| 1703 | <p>successful operation</p> | |
| 1704 | </div> | |
| 1705 | </div> | |
| 228e84aa C |
1706 | <div class="prop-row prop-inner"> |
| 1707 | <div class="prop-name">type</div> | |
| 1708 | <div class="prop-value"> | |
| 1709 | <span class="json-property-type"> | |
| 1710 | <span class="json-schema-ref-array"> | |
| 2963c343 | 1711 | <a class="json-schema-ref" href="#/definitions/VideoAbuse">VideoAbuse</a> |
| 228e84aa C |
1712 | </span> |
| 1713 | </span> | |
| 1714 | <span class="json-property-range" title="Value limits"></span> | |
| 1715 | </div> | |
| 1716 | </div> | |
| 5e1c08eb C |
1717 | </section> |
| 1718 | </div> | |
| 1719 | <div class="doc-examples"> | |
| 1720 | <h5>Response Content-Types: | |
| 1721 | <span>application/json</span> | |
| 1722 | </h5> | |
| 1723 | <section> | |
| 1724 | <h5>Response Example | |
| 1725 | <span>(200 OK)</span> | |
| 1726 | </h5> | |
| 1727 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 1728 | { | |
| 1729 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2963c343 RK |
1730 | <span class="hljs-attr">"reason"</span>: <span class="hljs-string">"string"</span>, |
| 1731 | <span class="hljs-attr">"reporterAccount"</span>: { | |
| 5e1c08eb C |
1732 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, |
| 1733 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1734 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 1735 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 1736 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 1737 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 1738 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1739 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 1740 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1741 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1742 | <span class="hljs-attr">"avatar"</span>: { | |
| 1743 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 1744 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1745 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1746 | } | |
| 1747 | }, | |
| 2963c343 RK |
1748 | <span class="hljs-attr">"video"</span>: { |
| 1749 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1750 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 1751 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 1752 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span> | |
| 1753 | }, | |
| 1754 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span> | |
| 5e1c08eb C |
1755 | } |
| 1756 | ] | |
| 1757 | </code></pre> | |
| 1758 | <!-- </div> --> | |
| 1759 | </section> | |
| 1760 | </div> | |
| 1761 | </div> | |
| 94ff4c23 C |
1762 | <div class="doc-row"> |
| 1763 | <div class="doc-copy"> | |
| 1764 | <section class="swagger-request-security"> | |
| 1765 | <table class="table"> | |
| 1766 | <thead> | |
| 1767 | <tr> | |
| 1768 | <th class="swagger-request-security-schema"></th> | |
| 1769 | <th class="swagger-request-security-scopes"></th> | |
| 1770 | </tr> | |
| 1771 | </thead> | |
| 1772 | <tbody> | |
| 1773 | <tr> | |
| 1774 | <td> | |
| 1775 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 1776 | </td> | |
| 1777 | <td> </td> | |
| 1778 | </tr> | |
| 1779 | </tbody> | |
| 1780 | </table> | |
| 1781 | </section> | |
| 1782 | </div> | |
| 1783 | </div> | |
| 5e1c08eb | 1784 | </div> |
| 2963c343 | 1785 | <div id="operation--videos--id--abuse-post" class="operation panel" data-traverse-target="operation--videos--id--abuse-post"> |
| 5e1c08eb C |
1786 | <!-- <section class="operation-tags row"> --> |
| 1787 | <!-- <div class="doc-copy"> --> | |
| 1788 | <div class="operation-tags"> | |
| 2963c343 | 1789 | <a class="label" href="#tag-VideoAbuse">VideoAbuse</a> |
| 5e1c08eb C |
1790 | <!----> |
| 1791 | </div> | |
| 1792 | <!-- </div> --> | |
| 1793 | <!-- </section> --> | |
| 1794 | <h2 class="operation-title"> | |
| 2963c343 | 1795 | <span class="operation-summary">Report an abuse, on a video by its id</span> |
| 5e1c08eb | 1796 | </h2> |
| 2963c343 RK |
1797 | <div class="doc-row"> |
| 1798 | <div class="doc-copy"> | |
| 1799 | <section class="swagger-operation-path"> | |
| 1800 | <span class="operation-method">POST</span> | |
| 1801 | <span class="operation-path">/videos/{id}/abuse</span> | |
| 1802 | </section> | |
| 1803 | </div> | |
| 1804 | </div> | |
| 5e1c08eb C |
1805 | <div class="doc-row"> |
| 1806 | <div class="doc-copy"> | |
| 1807 | <section class="swagger-request-params"> | |
| 1808 | <div class="prop-row prop-group"> | |
| 1809 | <div class="prop-name"> | |
| 330eaf12 C |
1810 | <div class="prop-title">id: |
| 1811 | <span class="prop-type"> | |
| 2963c343 | 1812 | <span class="json-property-type">string</span> |
| 330eaf12 C |
1813 | <span class="json-property-range" title="Value limits"></span> |
| 1814 | </span> | |
| 1815 | </div> | |
| 5e1c08eb | 1816 | <span class="json-property-required"></span> |
| 228e84aa | 1817 | <div class="prop-subtitle"> in path </div> |
| 5e1c08eb C |
1818 | </div> |
| 1819 | <div class="prop-value"> | |
| 2963c343 | 1820 | <p>The video id or uuid</p> |
| 5e1c08eb C |
1821 | </div> |
| 1822 | </div> | |
| 5e1c08eb C |
1823 | </section> |
| 1824 | </div> | |
| 1825 | <div class="doc-examples"></div> | |
| 1826 | </div> | |
| 1827 | <div class="doc-row"> | |
| 1828 | <div class="doc-copy"> | |
| 1829 | <section class="swagger-responses"> | |
| 1830 | <div class="prop-row prop-group"> | |
| 1831 | <div class="prop-name"> | |
| 1832 | <div class="prop-title">204 No Content</div> | |
| 1833 | </div> | |
| 1834 | <div class="prop-value"> | |
| 330eaf12 | 1835 | <p>Successful operation</p> |
| 5e1c08eb C |
1836 | </div> |
| 1837 | </div> | |
| 1838 | </section> | |
| 1839 | </div> | |
| 1840 | <div class="doc-examples"> | |
| 1841 | <h5>Response Content-Types: | |
| 1842 | <span>application/json</span> | |
| 1843 | </h5> | |
| 1844 | </div> | |
| 1845 | </div> | |
| 94ff4c23 C |
1846 | <div class="doc-row"> |
| 1847 | <div class="doc-copy"> | |
| 1848 | <section class="swagger-request-security"> | |
| 1849 | <table class="table"> | |
| 1850 | <thead> | |
| 1851 | <tr> | |
| 1852 | <th class="swagger-request-security-schema"></th> | |
| 1853 | <th class="swagger-request-security-scopes"></th> | |
| 1854 | </tr> | |
| 1855 | </thead> | |
| 1856 | <tbody> | |
| 1857 | <tr> | |
| 1858 | <td> | |
| 1859 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 1860 | </td> | |
| 1861 | <td> </td> | |
| 1862 | </tr> | |
| 1863 | </tbody> | |
| 1864 | </table> | |
| 1865 | </section> | |
| 1866 | </div> | |
| 1867 | </div> | |
| 5e1c08eb | 1868 | </div> |
| 2963c343 RK |
1869 | <h1 id="tag-Video" class="swagger-summary-tag" data-traverse-target="tag-Video">Video</h1> |
| 1870 | <div class="tag-description doc-row"> | |
| 1871 | <div class="doc-copy"> | |
| 1872 | <p>Operations dealing with listing, uploading, fetching or modifying videos.</p> | |
| 1873 | </div> | |
| 1874 | </div> | |
| 1875 | <div id="operation--accounts--name--videos-get" class="operation panel" data-traverse-target="operation--accounts--name--videos-get"> | |
| 5e1c08eb C |
1876 | <!-- <section class="operation-tags row"> --> |
| 1877 | <!-- <div class="doc-copy"> --> | |
| 1878 | <div class="operation-tags"> | |
| 2963c343 RK |
1879 | <a class="label" href="#tag-Accounts">Accounts</a> |
| 1880 | <!--, --> | |
| 1881 | <a class="label" href="#tag-Video">Video</a> | |
| 5e1c08eb C |
1882 | <!----> |
| 1883 | </div> | |
| 1884 | <!-- </div> --> | |
| 1885 | <!-- </section> --> | |
| 1886 | <h2 class="operation-title"> | |
| 2963c343 | 1887 | <span class="operation-summary">Get videos for an account, provided the name of that account</span> |
| 5e1c08eb | 1888 | </h2> |
| 2963c343 RK |
1889 | <div class="doc-row"> |
| 1890 | <div class="doc-copy"> | |
| 1891 | <section class="swagger-operation-path"> | |
| 1892 | <span class="operation-method">GET</span> | |
| 1893 | <span class="operation-path">/accounts/{name}/videos</span> | |
| 1894 | </section> | |
| 1895 | </div> | |
| 1896 | </div> | |
| 5e1c08eb C |
1897 | <div class="doc-row"> |
| 1898 | <div class="doc-copy"> | |
| 1899 | <section class="swagger-request-params"> | |
| 1900 | <div class="prop-row prop-group"> | |
| 1901 | <div class="prop-name"> | |
| 2963c343 | 1902 | <div class="prop-title">name: |
| 330eaf12 | 1903 | <span class="prop-type"> |
| 2963c343 | 1904 | <span class="json-property-type">string</span> |
| 330eaf12 C |
1905 | <span class="json-property-range" title="Value limits"></span> |
| 1906 | </span> | |
| 1907 | </div> | |
| 5e1c08eb | 1908 | <span class="json-property-required"></span> |
| 228e84aa | 1909 | <div class="prop-subtitle"> in path </div> |
| 5e1c08eb C |
1910 | </div> |
| 1911 | <div class="prop-value"> | |
| 2963c343 RK |
1912 | <p>The name of the account (chocobozzz or |
| 1913 | <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p> | |
| 5e1c08eb C |
1914 | </div> |
| 1915 | </div> | |
| 5e1c08eb C |
1916 | </section> |
| 1917 | </div> | |
| 1918 | <div class="doc-examples"></div> | |
| 1919 | </div> | |
| 1920 | <div class="doc-row"> | |
| 1921 | <div class="doc-copy"> | |
| 1922 | <section class="swagger-responses"> | |
| 1923 | <div class="prop-row prop-group"> | |
| 1924 | <div class="prop-name"> | |
| 1925 | <div class="prop-title">200 OK</div> | |
| 1926 | <div class="prop-ref"> | |
| 1927 | <span class=""> | |
| 2963c343 | 1928 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> |
| 5e1c08eb C |
1929 | </span> |
| 1930 | </div> | |
| 1931 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 1932 | </div> | |
| 1933 | <div class="prop-value"> | |
| 1934 | <p>successful operation</p> | |
| 1935 | </div> | |
| 1936 | </div> | |
| 1937 | </section> | |
| 1938 | </div> | |
| 1939 | <div class="doc-examples"> | |
| 1940 | <h5>Response Content-Types: | |
| 1941 | <span>application/json</span> | |
| 1942 | </h5> | |
| 1943 | <section> | |
| 1944 | <h5>Response Example | |
| 1945 | <span>(200 OK)</span> | |
| 1946 | </h5> | |
| 1947 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 1948 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2963c343 | 1949 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb | 1950 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
| 2963c343 RK |
1951 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, |
| 1952 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1953 | <span class="hljs-attr">"category"</span>: { | |
| 1954 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1955 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 1956 | }, | |
| 1957 | <span class="hljs-attr">"licence"</span>: { | |
| 1958 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 1959 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 1960 | }, | |
| 1961 | <span class="hljs-attr">"language"</span>: { | |
| 1962 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
| 1963 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 1964 | }, | |
| 1965 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | |
| 1966 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 1967 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 1968 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 1969 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 1970 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
| 1971 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
| 1972 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
| 1973 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 1974 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 1975 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 1976 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | |
| 5e1c08eb | 1977 | <span class="hljs-attr">"account"</span>: { |
| 2963c343 | 1978 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb | 1979 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb | 1980 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb | 1981 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb C |
1982 | <span class="hljs-attr">"avatar"</span>: { |
| 1983 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 1984 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 1985 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 1986 | } | |
| 2963c343 | 1987 | } |
| 5e1c08eb C |
1988 | } |
| 1989 | </code></pre> | |
| 1990 | <!-- </div> --> | |
| 1991 | </section> | |
| 1992 | </div> | |
| 1993 | </div> | |
| 1994 | </div> | |
| 2963c343 | 1995 | <div id="operation--videos-get" class="operation panel" data-traverse-target="operation--videos-get"> |
| 5e1c08eb C |
1996 | <!-- <section class="operation-tags row"> --> |
| 1997 | <!-- <div class="doc-copy"> --> | |
| 1998 | <div class="operation-tags"> | |
| 2963c343 | 1999 | <a class="label" href="#tag-Video">Video</a> |
| 5e1c08eb C |
2000 | <!----> |
| 2001 | </div> | |
| 2002 | <!-- </div> --> | |
| 2003 | <!-- </section> --> | |
| 2004 | <h2 class="operation-title"> | |
| 2963c343 | 2005 | <span class="operation-summary">Get list of videos</span> |
| 5e1c08eb C |
2006 | </h2> |
| 2007 | <div class="doc-row"> | |
| 2008 | <div class="doc-copy"> | |
| 2963c343 RK |
2009 | <section class="swagger-operation-path"> |
| 2010 | <span class="operation-method">GET</span> | |
| 2011 | <span class="operation-path">/videos</span> | |
| 2012 | </section> | |
| 2013 | </div> | |
| 2014 | </div> | |
| 2015 | <div class="doc-row"> | |
| 2016 | <div class="doc-copy"> | |
| 2017 | <section class="swagger-request-params"> | |
| 2018 | <div class="prop-row prop-group"> | |
| 5e1c08eb | 2019 | <div class="prop-name"> |
| 2963c343 RK |
2020 | <div class="prop-title">category: |
| 2021 | <span class="prop-type"> | |
| 2022 | <span class="json-property-type">number</span> | |
| 2023 | <span class="json-property-range" title="Value limits"></span> | |
| 5e1c08eb C |
2024 | </span> |
| 2025 | </div> | |
| 2963c343 | 2026 | <div class="prop-subtitle"> in query </div> |
| 5e1c08eb | 2027 | </div> |
| 2963c343 RK |
2028 | <div class="prop-value"> |
| 2029 | <p>category id of the video</p> | |
| 5e1c08eb C |
2030 | </div> |
| 2031 | </div> | |
| 5e1c08eb C |
2032 | <div class="prop-row prop-group"> |
| 2033 | <div class="prop-name"> | |
| 2963c343 | 2034 | <div class="prop-title">start: |
| 330eaf12 C |
2035 | <span class="prop-type"> |
| 2036 | <span class="json-property-type">number</span> | |
| 2037 | <span class="json-property-range" title="Value limits"></span> | |
| 2038 | </span> | |
| 2039 | </div> | |
| 2963c343 | 2040 | <div class="prop-subtitle"> in query </div> |
| 5e1c08eb C |
2041 | </div> |
| 2042 | <div class="prop-value"> | |
| 2963c343 | 2043 | <p>Offset</p> |
| 5e1c08eb C |
2044 | </div> |
| 2045 | </div> | |
| 5e1c08eb C |
2046 | <div class="prop-row prop-group"> |
| 2047 | <div class="prop-name"> | |
| 2963c343 RK |
2048 | <div class="prop-title">count: |
| 2049 | <span class="prop-type"> | |
| 2050 | <span class="json-property-type">number</span> | |
| 2051 | <span class="json-property-range" title="Value limits"></span> | |
| 2052 | </span> | |
| 2053 | </div> | |
| 2054 | <div class="prop-subtitle"> in query </div> | |
| 5e1c08eb C |
2055 | </div> |
| 2056 | <div class="prop-value"> | |
| 2963c343 RK |
2057 | <p>Number of items</p> |
| 2058 | </div> | |
| 2059 | </div> | |
| 2060 | <div class="prop-row prop-group"> | |
| 2061 | <div class="prop-name"> | |
| 2062 | <div class="prop-title">sort: | |
| 2063 | <span class="prop-type"> | |
| 2064 | <span class="json-property-type">string</span> | |
| 2065 | <span class="json-property-range" title="Value limits"></span> | |
| 2066 | </span> | |
| 2067 | </div> | |
| 2068 | <div class="prop-subtitle"> in query </div> | |
| 2069 | </div> | |
| 2070 | <div class="prop-value"> | |
| 2071 | <p>Sort column (-createdAt for example)</p> | |
| 5e1c08eb C |
2072 | </div> |
| 2073 | </div> | |
| 2074 | </section> | |
| 2075 | </div> | |
| 5e1c08eb C |
2076 | <div class="doc-examples"></div> |
| 2077 | </div> | |
| 2078 | <div class="doc-row"> | |
| 2079 | <div class="doc-copy"> | |
| 2080 | <section class="swagger-responses"> | |
| 2081 | <div class="prop-row prop-group"> | |
| 2082 | <div class="prop-name"> | |
| 2083 | <div class="prop-title">200 OK</div> | |
| 2084 | <div class="prop-ref"> | |
| 2085 | <span class="json-schema-ref-array"> | |
| 2963c343 | 2086 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> |
| 5e1c08eb C |
2087 | </span> |
| 2088 | </div> | |
| 2089 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 2090 | </div> | |
| 2091 | <div class="prop-value"> | |
| 2092 | <p>successful operation</p> | |
| 2093 | </div> | |
| 2094 | </div> | |
| 228e84aa C |
2095 | <div class="prop-row prop-inner"> |
| 2096 | <div class="prop-name">type</div> | |
| 2097 | <div class="prop-value"> | |
| 2098 | <span class="json-property-type"> | |
| 2099 | <span class="json-schema-ref-array"> | |
| 2963c343 | 2100 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> |
| 228e84aa C |
2101 | </span> |
| 2102 | </span> | |
| 2103 | <span class="json-property-range" title="Value limits"></span> | |
| 2104 | </div> | |
| 2105 | </div> | |
| 5e1c08eb C |
2106 | </section> |
| 2107 | </div> | |
| 2108 | <div class="doc-examples"> | |
| 2109 | <h5>Response Content-Types: | |
| 2110 | <span>application/json</span> | |
| 2111 | </h5> | |
| 2112 | <section> | |
| 2113 | <h5>Response Example | |
| 2114 | <span>(200 OK)</span> | |
| 2115 | </h5> | |
| 2116 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 2117 | { | |
| 2118 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2963c343 | 2119 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb | 2120 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
| 2963c343 RK |
2121 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, |
| 2122 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 2123 | <span class="hljs-attr">"category"</span>: { | |
| 2124 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2125 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 2126 | }, | |
| 2127 | <span class="hljs-attr">"licence"</span>: { | |
| 2128 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2129 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 2130 | }, | |
| 2131 | <span class="hljs-attr">"language"</span>: { | |
| 2132 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
| 2133 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 2134 | }, | |
| 2135 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | |
| 2136 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 2137 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 2138 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 2139 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 2140 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
| 2141 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
| 2142 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
| 2143 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 2144 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 2145 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 2146 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | |
| 5e1c08eb | 2147 | <span class="hljs-attr">"account"</span>: { |
| 2963c343 | 2148 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb | 2149 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb | 2150 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb | 2151 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb C |
2152 | <span class="hljs-attr">"avatar"</span>: { |
| 2153 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 2154 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 2155 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 2156 | } | |
| 2963c343 | 2157 | } |
| 5e1c08eb C |
2158 | } |
| 2159 | ] | |
| 2160 | </code></pre> | |
| 2161 | <!-- </div> --> | |
| 2162 | </section> | |
| 2163 | </div> | |
| 2164 | </div> | |
| 2165 | </div> | |
| 2963c343 | 2166 | <div id="operation--videos-categories-get" class="operation panel" data-traverse-target="operation--videos-categories-get"> |
| 5e1c08eb C |
2167 | <!-- <section class="operation-tags row"> --> |
| 2168 | <!-- <div class="doc-copy"> --> | |
| 2169 | <div class="operation-tags"> | |
| 2963c343 | 2170 | <a class="label" href="#tag-Video">Video</a> |
| 5e1c08eb C |
2171 | <!----> |
| 2172 | </div> | |
| 2173 | <!-- </div> --> | |
| 2174 | <!-- </section> --> | |
| 2175 | <h2 class="operation-title"> | |
| 2963c343 | 2176 | <span class="operation-summary">Get list of video licences known by the server</span> |
| 5e1c08eb C |
2177 | </h2> |
| 2178 | <div class="doc-row"> | |
| 2179 | <div class="doc-copy"> | |
| 2963c343 RK |
2180 | <section class="swagger-operation-path"> |
| 2181 | <span class="operation-method">GET</span> | |
| 2182 | <span class="operation-path">/videos/categories</span> | |
| 5e1c08eb C |
2183 | </section> |
| 2184 | </div> | |
| 2185 | </div> | |
| 2963c343 RK |
2186 | <div class="doc-row"> |
| 2187 | <div class="doc-copy"> </div> | |
| 2188 | <div class="doc-examples"></div> | |
| 2189 | </div> | |
| 5e1c08eb C |
2190 | <div class="doc-row"> |
| 2191 | <div class="doc-copy"> | |
| 2192 | <section class="swagger-responses"> | |
| 2193 | <div class="prop-row prop-group"> | |
| 2194 | <div class="prop-name"> | |
| 2963c343 RK |
2195 | <div class="prop-title">200 OK</div> |
| 2196 | <div class="prop-ref"></div> | |
| 2197 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 5e1c08eb C |
2198 | </div> |
| 2199 | <div class="prop-value"> | |
| 2963c343 RK |
2200 | <p>successful operation</p> |
| 2201 | </div> | |
| 2202 | </div> | |
| 2203 | <div class="prop-row prop-inner"> | |
| 2204 | <div class="prop-name">type</div> | |
| 2205 | <div class="prop-value"> | |
| 2206 | <span class="json-property-type">string[]</span> | |
| 2207 | <span class="json-property-range" title="Value limits"></span> | |
| 5e1c08eb C |
2208 | </div> |
| 2209 | </div> | |
| 2210 | </section> | |
| 2211 | </div> | |
| 2212 | <div class="doc-examples"> | |
| 2213 | <h5>Response Content-Types: | |
| 2214 | <span>application/json</span> | |
| 2215 | </h5> | |
| 2963c343 RK |
2216 | <section> |
| 2217 | <h5>Response Example | |
| 2218 | <span>(200 OK)</span> | |
| 2219 | </h5> | |
| 2220 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 2221 | <span class="hljs-string">"string"</span> | |
| 2222 | ] | |
| 2223 | </code></pre> | |
| 2224 | <!-- </div> --> | |
| 94ff4c23 C |
2225 | </section> |
| 2226 | </div> | |
| 2227 | </div> | |
| 5e1c08eb | 2228 | </div> |
| 2963c343 | 2229 | <div id="operation--videos-licences-get" class="operation panel" data-traverse-target="operation--videos-licences-get"> |
| 5e1c08eb C |
2230 | <!-- <section class="operation-tags row"> --> |
| 2231 | <!-- <div class="doc-copy"> --> | |
| 2232 | <div class="operation-tags"> | |
| 2963c343 | 2233 | <a class="label" href="#tag-Video">Video</a> |
| 5e1c08eb C |
2234 | <!----> |
| 2235 | </div> | |
| 2236 | <!-- </div> --> | |
| 2237 | <!-- </section> --> | |
| 2238 | <h2 class="operation-title"> | |
| 2963c343 | 2239 | <span class="operation-summary">Get list of video licences known by the server</span> |
| 5e1c08eb | 2240 | </h2> |
| 2963c343 RK |
2241 | <div class="doc-row"> |
| 2242 | <div class="doc-copy"> | |
| 2243 | <section class="swagger-operation-path"> | |
| 2244 | <span class="operation-method">GET</span> | |
| 2245 | <span class="operation-path">/videos/licences</span> | |
| 2246 | </section> | |
| 2247 | </div> | |
| 2248 | </div> | |
| 5e1c08eb C |
2249 | <div class="doc-row"> |
| 2250 | <div class="doc-copy"> </div> | |
| 2251 | <div class="doc-examples"></div> | |
| 2252 | </div> | |
| 2253 | <div class="doc-row"> | |
| 2254 | <div class="doc-copy"> | |
| 2255 | <section class="swagger-responses"> | |
| 2256 | <div class="prop-row prop-group"> | |
| 2257 | <div class="prop-name"> | |
| 2258 | <div class="prop-title">200 OK</div> | |
| 2963c343 | 2259 | <div class="prop-ref"></div> |
| 5e1c08eb C |
2260 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> |
| 2261 | </div> | |
| 2262 | <div class="prop-value"> | |
| 2263 | <p>successful operation</p> | |
| 2264 | </div> | |
| 2265 | </div> | |
| 228e84aa C |
2266 | <div class="prop-row prop-inner"> |
| 2267 | <div class="prop-name">type</div> | |
| 2268 | <div class="prop-value"> | |
| 2963c343 | 2269 | <span class="json-property-type">string[]</span> |
| 228e84aa C |
2270 | <span class="json-property-range" title="Value limits"></span> |
| 2271 | </div> | |
| 2272 | </div> | |
| 5e1c08eb C |
2273 | </section> |
| 2274 | </div> | |
| 2275 | <div class="doc-examples"> | |
| 2276 | <h5>Response Content-Types: | |
| 2277 | <span>application/json</span> | |
| 2278 | </h5> | |
| 2279 | <section> | |
| 2280 | <h5>Response Example | |
| 2281 | <span>(200 OK)</span> | |
| 2282 | </h5> | |
| 2963c343 RK |
2283 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ |
| 2284 | <span class="hljs-string">"string"</span> | |
| 2285 | ] | |
| 5e1c08eb C |
2286 | </code></pre> |
| 2287 | <!-- </div> --> | |
| 2288 | </section> | |
| 2289 | </div> | |
| 2290 | </div> | |
| 2291 | </div> | |
| 2963c343 | 2292 | <div id="operation--videos-languages-get" class="operation panel" data-traverse-target="operation--videos-languages-get"> |
| 5e1c08eb C |
2293 | <!-- <section class="operation-tags row"> --> |
| 2294 | <!-- <div class="doc-copy"> --> | |
| 2295 | <div class="operation-tags"> | |
| 2963c343 | 2296 | <a class="label" href="#tag-Video">Video</a> |
| 5e1c08eb C |
2297 | <!----> |
| 2298 | </div> | |
| 2299 | <!-- </div> --> | |
| 2300 | <!-- </section> --> | |
| 2301 | <h2 class="operation-title"> | |
| 2963c343 | 2302 | <span class="operation-summary">Get list of languages known by the server</span> |
| 5e1c08eb C |
2303 | </h2> |
| 2304 | <div class="doc-row"> | |
| 2305 | <div class="doc-copy"> | |
| 2963c343 RK |
2306 | <section class="swagger-operation-path"> |
| 2307 | <span class="operation-method">GET</span> | |
| 2308 | <span class="operation-path">/videos/languages</span> | |
| 5e1c08eb C |
2309 | </section> |
| 2310 | </div> | |
| 2963c343 RK |
2311 | </div> |
| 2312 | <div class="doc-row"> | |
| 2313 | <div class="doc-copy"> </div> | |
| 5e1c08eb C |
2314 | <div class="doc-examples"></div> |
| 2315 | </div> | |
| 2316 | <div class="doc-row"> | |
| 2317 | <div class="doc-copy"> | |
| 2318 | <section class="swagger-responses"> | |
| 2319 | <div class="prop-row prop-group"> | |
| 2320 | <div class="prop-name"> | |
| 2321 | <div class="prop-title">200 OK</div> | |
| 2963c343 | 2322 | <div class="prop-ref"></div> |
| 5e1c08eb C |
2323 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> |
| 2324 | </div> | |
| 2325 | <div class="prop-value"> | |
| 2326 | <p>successful operation</p> | |
| 2327 | </div> | |
| 2328 | </div> | |
| 2963c343 RK |
2329 | <div class="prop-row prop-inner"> |
| 2330 | <div class="prop-name">type</div> | |
| 2331 | <div class="prop-value"> | |
| 2332 | <span class="json-property-type">string[]</span> | |
| 2333 | <span class="json-property-range" title="Value limits"></span> | |
| 2334 | </div> | |
| 2335 | </div> | |
| 5e1c08eb C |
2336 | </section> |
| 2337 | </div> | |
| 2338 | <div class="doc-examples"> | |
| 2339 | <h5>Response Content-Types: | |
| 2340 | <span>application/json</span> | |
| 2341 | </h5> | |
| 2342 | <section> | |
| 2343 | <h5>Response Example | |
| 2344 | <span>(200 OK)</span> | |
| 2345 | </h5> | |
| 2963c343 RK |
2346 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ |
| 2347 | <span class="hljs-string">"string"</span> | |
| 2348 | ] | |
| 5e1c08eb C |
2349 | </code></pre> |
| 2350 | <!-- </div> --> | |
| 2351 | </section> | |
| 2352 | </div> | |
| 2353 | </div> | |
| 2963c343 RK |
2354 | </div> |
| 2355 | <div id="operation--videos-privacies-get" class="operation panel" data-traverse-target="operation--videos-privacies-get"> | |
| 2356 | <!-- <section class="operation-tags row"> --> | |
| 2357 | <!-- <div class="doc-copy"> --> | |
| 2358 | <div class="operation-tags"> | |
| 2359 | <a class="label" href="#tag-Video">Video</a> | |
| 2360 | <!----> | |
| 2361 | </div> | |
| 2362 | <!-- </div> --> | |
| 2363 | <!-- </section> --> | |
| 2364 | <h2 class="operation-title"> | |
| 2365 | <span class="operation-summary">Get list of privacy policies supported by the server</span> | |
| 2366 | </h2> | |
| 94ff4c23 C |
2367 | <div class="doc-row"> |
| 2368 | <div class="doc-copy"> | |
| 2963c343 RK |
2369 | <section class="swagger-operation-path"> |
| 2370 | <span class="operation-method">GET</span> | |
| 2371 | <span class="operation-path">/videos/privacies</span> | |
| 94ff4c23 C |
2372 | </section> |
| 2373 | </div> | |
| 2374 | </div> | |
| 5e1c08eb | 2375 | <div class="doc-row"> |
| 2963c343 | 2376 | <div class="doc-copy"> </div> |
| 5e1c08eb C |
2377 | <div class="doc-examples"></div> |
| 2378 | </div> | |
| 2379 | <div class="doc-row"> | |
| 2380 | <div class="doc-copy"> | |
| 2381 | <section class="swagger-responses"> | |
| 2382 | <div class="prop-row prop-group"> | |
| 2383 | <div class="prop-name"> | |
| 2384 | <div class="prop-title">200 OK</div> | |
| 2963c343 | 2385 | <div class="prop-ref"></div> |
| 5e1c08eb C |
2386 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> |
| 2387 | </div> | |
| 2388 | <div class="prop-value"> | |
| 2389 | <p>successful operation</p> | |
| 2390 | </div> | |
| 2391 | </div> | |
| 228e84aa C |
2392 | <div class="prop-row prop-inner"> |
| 2393 | <div class="prop-name">type</div> | |
| 2394 | <div class="prop-value"> | |
| 2963c343 | 2395 | <span class="json-property-type">string[]</span> |
| 228e84aa C |
2396 | <span class="json-property-range" title="Value limits"></span> |
| 2397 | </div> | |
| 2398 | </div> | |
| 5e1c08eb C |
2399 | </section> |
| 2400 | </div> | |
| 2401 | <div class="doc-examples"> | |
| 2402 | <h5>Response Content-Types: | |
| 2403 | <span>application/json</span> | |
| 2404 | </h5> | |
| 2405 | <section> | |
| 2406 | <h5>Response Example | |
| 2407 | <span>(200 OK)</span> | |
| 2408 | </h5> | |
| 2409 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 2963c343 | 2410 | <span class="hljs-string">"string"</span> |
| 5e1c08eb C |
2411 | ] |
| 2412 | </code></pre> | |
| 2413 | <!-- </div> --> | |
| 2414 | </section> | |
| 2415 | </div> | |
| 2416 | </div> | |
| 2417 | </div> | |
| 2963c343 | 2418 | <div id="operation--videos--id--put" class="operation panel" data-traverse-target="operation--videos--id--put"> |
| 5e1c08eb C |
2419 | <!-- <section class="operation-tags row"> --> |
| 2420 | <!-- <div class="doc-copy"> --> | |
| 2421 | <div class="operation-tags"> | |
| 2963c343 | 2422 | <a class="label" href="#tag-Video">Video</a> |
| 5e1c08eb C |
2423 | <!----> |
| 2424 | </div> | |
| 2425 | <!-- </div> --> | |
| 2426 | <!-- </section> --> | |
| 2427 | <h2 class="operation-title"> | |
| 2963c343 | 2428 | <span class="operation-summary">Update metadata for a video by its id</span> |
| 5e1c08eb C |
2429 | </h2> |
| 2430 | <div class="doc-row"> | |
| 2431 | <div class="doc-copy"> | |
| 2963c343 RK |
2432 | <section class="swagger-operation-path"> |
| 2433 | <span class="operation-method">PUT</span> | |
| 2434 | <span class="operation-path">/videos/{id}</span> | |
| 2435 | </section> | |
| 2436 | </div> | |
| 2437 | </div> | |
| 2438 | <div class="doc-row"> | |
| 2439 | <div class="doc-copy"> | |
| 2440 | <section class="swagger-request-params"> | |
| 2441 | <div class="prop-row prop-group"> | |
| 5e1c08eb | 2442 | <div class="prop-name"> |
| 2963c343 RK |
2443 | <div class="prop-title">id: |
| 2444 | <span class="prop-type"> | |
| 2445 | <span class="json-property-type">string</span> | |
| 2446 | <span class="json-property-range" title="Value limits"></span> | |
| 5e1c08eb C |
2447 | </span> |
| 2448 | </div> | |
| 2963c343 RK |
2449 | <span class="json-property-required"></span> |
| 2450 | <div class="prop-subtitle"> in path </div> | |
| 5e1c08eb | 2451 | </div> |
| 2963c343 RK |
2452 | <div class="prop-value"> |
| 2453 | <p>The video id or uuid</p> | |
| 5e1c08eb C |
2454 | </div> |
| 2455 | </div> | |
| 5e1c08eb C |
2456 | <div class="prop-row prop-group"> |
| 2457 | <div class="prop-name"> | |
| 2963c343 RK |
2458 | <div class="prop-title">thumbnailfile: |
| 2459 | <span class="prop-type"> | |
| 2460 | <span class="json-property-type">file</span> | |
| 2461 | <span class="json-property-range" title="Value limits"></span> | |
| 2462 | </span> | |
| 2463 | </div> | |
| 2464 | <div class="prop-subtitle"> in formData </div> | |
| 5e1c08eb C |
2465 | </div> |
| 2466 | <div class="prop-value"> | |
| 2963c343 | 2467 | <p>Video thumbnail file</p> |
| 5e1c08eb C |
2468 | </div> |
| 2469 | </div> | |
| 5e1c08eb C |
2470 | <div class="prop-row prop-group"> |
| 2471 | <div class="prop-name"> | |
| 2963c343 | 2472 | <div class="prop-title">previewfile: |
| 330eaf12 C |
2473 | <span class="prop-type"> |
| 2474 | <span class="json-property-type">file</span> | |
| 2475 | <span class="json-property-range" title="Value limits"></span> | |
| 2476 | </span> | |
| 228e84aa | 2477 | </div> |
| 330eaf12 | 2478 | <div class="prop-subtitle"> in formData </div> |
| 5e1c08eb C |
2479 | </div> |
| 2480 | <div class="prop-value"> | |
| 2963c343 | 2481 | <p>Video preview file</p> |
| 5e1c08eb C |
2482 | </div> |
| 2483 | </div> | |
| 5e1c08eb C |
2484 | <div class="prop-row prop-group"> |
| 2485 | <div class="prop-name"> | |
| 2963c343 RK |
2486 | <div class="prop-title">category: |
| 2487 | <span class="prop-type"> | |
| 2488 | <span class="json-property-type">number</span> | |
| 2489 | <span class="json-property-range" title="Value limits"></span> | |
| 5e1c08eb C |
2490 | </span> |
| 2491 | </div> | |
| 2963c343 | 2492 | <div class="prop-subtitle"> in formData </div> |
| 5e1c08eb C |
2493 | </div> |
| 2494 | <div class="prop-value"> | |
| 2963c343 | 2495 | <p>Video category</p> |
| 5e1c08eb C |
2496 | </div> |
| 2497 | </div> | |
| ab0ee6a1 C |
2498 | <div class="prop-row prop-group"> |
| 2499 | <div class="prop-name"> | |
| 2963c343 | 2500 | <div class="prop-title">licence: |
| 330eaf12 C |
2501 | <span class="prop-type"> |
| 2502 | <span class="json-property-type">number</span> | |
| 2503 | <span class="json-property-range" title="Value limits"></span> | |
| 2504 | </span> | |
| 228e84aa | 2505 | </div> |
| 2963c343 | 2506 | <div class="prop-subtitle"> in formData </div> |
| ab0ee6a1 C |
2507 | </div> |
| 2508 | <div class="prop-value"> | |
| 2963c343 | 2509 | <p>Video licence</p> |
| ab0ee6a1 C |
2510 | </div> |
| 2511 | </div> | |
| ab0ee6a1 C |
2512 | <div class="prop-row prop-group"> |
| 2513 | <div class="prop-name"> | |
| 2963c343 | 2514 | <div class="prop-title">language: |
| 330eaf12 | 2515 | <span class="prop-type"> |
| 2963c343 | 2516 | <span class="json-property-type">string</span> |
| 330eaf12 C |
2517 | <span class="json-property-range" title="Value limits"></span> |
| 2518 | </span> | |
| 228e84aa | 2519 | </div> |
| 2963c343 | 2520 | <div class="prop-subtitle"> in formData </div> |
| ab0ee6a1 C |
2521 | </div> |
| 2522 | <div class="prop-value"> | |
| 2963c343 | 2523 | <p>Video language</p> |
| ab0ee6a1 C |
2524 | </div> |
| 2525 | </div> | |
| ab0ee6a1 C |
2526 | <div class="prop-row prop-group"> |
| 2527 | <div class="prop-name"> | |
| 2963c343 | 2528 | <div class="prop-title">description: |
| 330eaf12 | 2529 | <span class="prop-type"> |
| 2963c343 | 2530 | <span class="json-property-type">string</span> |
| 330eaf12 C |
2531 | <span class="json-property-range" title="Value limits"></span> |
| 2532 | </span> | |
| 2533 | </div> | |
| 2963c343 | 2534 | <div class="prop-subtitle"> in formData </div> |
| 330eaf12 C |
2535 | </div> |
| 2536 | <div class="prop-value"> | |
| 2963c343 | 2537 | <p>Video description</p> |
| 330eaf12 C |
2538 | </div> |
| 2539 | </div> | |
| 2540 | <div class="prop-row prop-group"> | |
| 2541 | <div class="prop-name"> | |
| 2963c343 RK |
2542 | <div class="prop-title">waitTranscoding: |
| 2543 | <span class="prop-type"> | |
| 2544 | <span class="json-property-type">boolean</span> | |
| 2545 | <span class="json-property-range" title="Value limits"></span> | |
| 2546 | </span> | |
| 2547 | </div> | |
| 2548 | <div class="prop-subtitle"> in formData </div> | |
| 2549 | </div> | |
| 2550 | <div class="prop-value"> | |
| 2551 | <p>Whether or not we wait transcoding before publish the video</p> | |
| 2552 | </div> | |
| 2553 | </div> | |
| 2554 | <div class="prop-row prop-group"> | |
| 2555 | <div class="prop-name"> | |
| 2556 | <div class="prop-title">support: | |
| 330eaf12 C |
2557 | <span class="prop-type"> |
| 2558 | <span class="json-property-type">string</span> | |
| 2559 | <span class="json-property-range" title="Value limits"></span> | |
| 2560 | </span> | |
| 228e84aa | 2561 | </div> |
| 2963c343 | 2562 | <div class="prop-subtitle"> in formData </div> |
| ab0ee6a1 C |
2563 | </div> |
| 2564 | <div class="prop-value"> | |
| 2963c343 RK |
2565 | <p>Text describing how to support the video uploader</p> |
| 2566 | </div> | |
| 2567 | </div> | |
| 2568 | <div class="prop-row prop-group"> | |
| 2569 | <div class="prop-name"> | |
| 2570 | <div class="prop-title">nsfw: | |
| 2571 | <span class="prop-type"> | |
| 2572 | <span class="json-property-type">boolean</span> | |
| 2573 | <span class="json-property-range" title="Value limits"></span> | |
| 2574 | </span> | |
| 2575 | </div> | |
| 2576 | <div class="prop-subtitle"> in formData </div> | |
| 2577 | </div> | |
| 2578 | <div class="prop-value"> | |
| 2579 | <p>Whether or not this video contains sensitive content</p> | |
| 2580 | </div> | |
| 2581 | </div> | |
| 2582 | <div class="prop-row prop-group"> | |
| 2583 | <div class="prop-name"> | |
| 2584 | <div class="prop-title">name: | |
| 2585 | <span class="prop-type"> | |
| 2586 | <span class="json-property-type">string</span> | |
| 2587 | <span class="json-property-range" title="Value limits"></span> | |
| 2588 | </span> | |
| 2589 | </div> | |
| 2590 | <div class="prop-subtitle"> in formData </div> | |
| 2591 | </div> | |
| 2592 | <div class="prop-value"> | |
| 2593 | <p>Video name</p> | |
| 2594 | </div> | |
| 2595 | </div> | |
| 2596 | <div class="prop-row prop-group"> | |
| 2597 | <div class="prop-name"> | |
| 2598 | <div class="prop-title">tags: | |
| 2599 | <span class="prop-type"> | |
| 2600 | <span class="json-property-type">string[]</span> | |
| 2601 | <span class="json-property-range" title="Value limits"></span> | |
| 2602 | </span> | |
| 2603 | </div> | |
| 2604 | <div class="prop-subtitle"> in formData </div> | |
| 2605 | </div> | |
| 2606 | <div class="prop-value"> | |
| 2607 | <p>Video tags</p> | |
| 2608 | </div> | |
| 2609 | </div> | |
| 2610 | <div class="prop-row prop-group"> | |
| 2611 | <div class="prop-name"> | |
| 2612 | <div class="prop-title">commentsEnabled: | |
| 2613 | <span class="prop-type"> | |
| 2614 | <span class="json-property-type">boolean</span> | |
| 2615 | <span class="json-property-range" title="Value limits"></span> | |
| 2616 | </span> | |
| 2617 | </div> | |
| 2618 | <div class="prop-subtitle"> in formData </div> | |
| 2619 | </div> | |
| 2620 | <div class="prop-value"> | |
| 2621 | <p>Enable or disable comments for this video</p> | |
| 2622 | </div> | |
| 2623 | </div> | |
| 2624 | <div class="prop-row prop-group"> | |
| 2625 | <div class="prop-name"> | |
| 2626 | <div class="prop-title">privacy: | |
| 2627 | <span class="prop-type"> | |
| 2628 | <span class="json-property-type">string</span> | |
| 2629 | <span class="json-property-enum" title="Possible values"> | |
| 2630 | <span class="json-property-enum-item">Public</span>, | |
| 2631 | <span class="json-property-enum-item">Unlisted</span> | |
| 2632 | </span> | |
| 2633 | <span class="json-property-range" title="Value limits"></span> | |
| 2634 | </span> | |
| 2635 | </div> | |
| 2636 | <div class="prop-subtitle"> in formData </div> | |
| 2637 | </div> | |
| 2638 | <div class="prop-value"> | |
| 2639 | <p>Video privacy</p> | |
| 2640 | </div> | |
| 2641 | </div> | |
| 2642 | <div class="prop-row prop-group"> | |
| 2643 | <div class="prop-name"> | |
| 2644 | <div class="prop-title">scheduleUpdate: | |
| 2645 | <span class="prop-type"> | |
| 2646 | <span class="json-property-type">object</span> | |
| 2647 | <span class="json-property-range" title="Value limits"></span> | |
| 2648 | </span> | |
| 2649 | </div> | |
| 2650 | <div class="prop-subtitle"> in formData </div> | |
| 2651 | </div> | |
| 2652 | <div class="prop-value"> | |
| 2653 | <p>Schedule an update at a specific datetime</p> | |
| ab0ee6a1 C |
2654 | </div> |
| 2655 | </div> | |
| ab0ee6a1 C |
2656 | </section> |
| 2657 | </div> | |
| 5e1c08eb C |
2658 | <div class="doc-examples"></div> |
| 2659 | </div> | |
| 2660 | <div class="doc-row"> | |
| 2661 | <div class="doc-copy"> | |
| 2662 | <section class="swagger-responses"> | |
| 2663 | <div class="prop-row prop-group"> | |
| 2664 | <div class="prop-name"> | |
| 2665 | <div class="prop-title">200 OK</div> | |
| 2666 | <div class="prop-ref"> | |
| 2963c343 | 2667 | <span class=""> |
| 5e1c08eb C |
2668 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> |
| 2669 | </span> | |
| 2670 | </div> | |
| 2671 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 2672 | </div> | |
| 2673 | <div class="prop-value"> | |
| 2674 | <p>successful operation</p> | |
| 2675 | </div> | |
| 2676 | </div> | |
| 2677 | </section> | |
| 2678 | </div> | |
| 2679 | <div class="doc-examples"> | |
| 2680 | <h5>Response Content-Types: | |
| 2681 | <span>application/json</span> | |
| 2682 | </h5> | |
| 2683 | <section> | |
| 2684 | <h5>Response Example | |
| 2685 | <span>(200 OK)</span> | |
| 2686 | </h5> | |
| 2963c343 RK |
2687 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ |
| 2688 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2689 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 2690 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 2691 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 2692 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 2693 | <span class="hljs-attr">"category"</span>: { | |
| 5e1c08eb | 2694 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, |
| 2963c343 RK |
2695 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
| 2696 | }, | |
| 2697 | <span class="hljs-attr">"licence"</span>: { | |
| 2698 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2699 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 2700 | }, | |
| 2701 | <span class="hljs-attr">"language"</span>: { | |
| 2702 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
| 2703 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 2704 | }, | |
| 2705 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | |
| 2706 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 2707 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 2708 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 2709 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 2710 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
| 2711 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
| 2712 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
| 2713 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 2714 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 2715 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 2716 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | |
| 2717 | <span class="hljs-attr">"account"</span>: { | |
| 5e1c08eb | 2718 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, |
| 2963c343 RK |
2719 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, |
| 2720 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 2721 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 2722 | <span class="hljs-attr">"avatar"</span>: { | |
| 2723 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 2724 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 2725 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 61b66b36 | 2726 | } |
| 5e1c08eb | 2727 | } |
| 2963c343 | 2728 | } |
| 5e1c08eb C |
2729 | </code></pre> |
| 2730 | <!-- </div> --> | |
| 2731 | </section> | |
| 2732 | </div> | |
| 2733 | </div> | |
| 2963c343 RK |
2734 | <div class="doc-row"> |
| 2735 | <div class="doc-copy"> | |
| 2736 | <section class="swagger-request-security"> | |
| 2737 | <table class="table"> | |
| 2738 | <thead> | |
| 2739 | <tr> | |
| 2740 | <th class="swagger-request-security-schema"></th> | |
| 2741 | <th class="swagger-request-security-scopes"></th> | |
| 2742 | </tr> | |
| 2743 | </thead> | |
| 2744 | <tbody> | |
| 2745 | <tr> | |
| 2746 | <td> | |
| 2747 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 2748 | </td> | |
| 2749 | <td> </td> | |
| 2750 | </tr> | |
| 2751 | </tbody> | |
| 2752 | </table> | |
| 2753 | </section> | |
| 2754 | </div> | |
| 2755 | </div> | |
| 5e1c08eb | 2756 | </div> |
| 2963c343 | 2757 | <div id="operation--videos--id--get" class="operation panel" data-traverse-target="operation--videos--id--get"> |
| 5e1c08eb C |
2758 | <!-- <section class="operation-tags row"> --> |
| 2759 | <!-- <div class="doc-copy"> --> | |
| 2760 | <div class="operation-tags"> | |
| 2761 | <a class="label" href="#tag-Video">Video</a> | |
| 2762 | <!----> | |
| 2763 | </div> | |
| 2764 | <!-- </div> --> | |
| 2765 | <!-- </section> --> | |
| 2766 | <h2 class="operation-title"> | |
| 2963c343 | 2767 | <span class="operation-summary">Get a video by its id</span> |
| 5e1c08eb C |
2768 | </h2> |
| 2769 | <div class="doc-row"> | |
| 2963c343 RK |
2770 | <div class="doc-copy"> |
| 2771 | <section class="swagger-operation-path"> | |
| 2772 | <span class="operation-method">GET</span> | |
| 2773 | <span class="operation-path">/videos/{id}</span> | |
| 2774 | </section> | |
| 2775 | </div> | |
| 5e1c08eb C |
2776 | </div> |
| 2777 | <div class="doc-row"> | |
| 2778 | <div class="doc-copy"> | |
| 2963c343 | 2779 | <section class="swagger-request-params"> |
| 5e1c08eb C |
2780 | <div class="prop-row prop-group"> |
| 2781 | <div class="prop-name"> | |
| 2963c343 RK |
2782 | <div class="prop-title">id: |
| 2783 | <span class="prop-type"> | |
| 2784 | <span class="json-property-type">string</span> | |
| 2785 | <span class="json-property-range" title="Value limits"></span> | |
| 2786 | </span> | |
| 2787 | </div> | |
| 2788 | <span class="json-property-required"></span> | |
| 2789 | <div class="prop-subtitle"> in path </div> | |
| 5e1c08eb | 2790 | </div> |
| 228e84aa | 2791 | <div class="prop-value"> |
| 2963c343 | 2792 | <p>The video id or uuid</p> |
| 228e84aa C |
2793 | </div> |
| 2794 | </div> | |
| 5e1c08eb C |
2795 | </section> |
| 2796 | </div> | |
| 5e1c08eb C |
2797 | <div class="doc-examples"></div> |
| 2798 | </div> | |
| 2799 | <div class="doc-row"> | |
| 2800 | <div class="doc-copy"> | |
| 2801 | <section class="swagger-responses"> | |
| 2802 | <div class="prop-row prop-group"> | |
| 2803 | <div class="prop-name"> | |
| 2804 | <div class="prop-title">200 OK</div> | |
| 2963c343 RK |
2805 | <div class="prop-ref"> |
| 2806 | <span class=""> | |
| 2807 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
| 2808 | </span> | |
| 2809 | </div> | |
| 5e1c08eb C |
2810 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> |
| 2811 | </div> | |
| 2812 | <div class="prop-value"> | |
| 2813 | <p>successful operation</p> | |
| 2814 | </div> | |
| 2815 | </div> | |
| 2816 | </section> | |
| 2817 | </div> | |
| 2818 | <div class="doc-examples"> | |
| 2819 | <h5>Response Content-Types: | |
| 2820 | <span>application/json</span> | |
| 2821 | </h5> | |
| 2822 | <section> | |
| 2823 | <h5>Response Example | |
| 2824 | <span>(200 OK)</span> | |
| 2825 | </h5> | |
| 2963c343 RK |
2826 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ |
| 2827 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2828 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 2829 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 2830 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 2831 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 2832 | <span class="hljs-attr">"category"</span>: { | |
| 2833 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2834 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 2835 | }, | |
| 2836 | <span class="hljs-attr">"licence"</span>: { | |
| 2837 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2838 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 2839 | }, | |
| 2840 | <span class="hljs-attr">"language"</span>: { | |
| 2841 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
| 2842 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 2843 | }, | |
| 2844 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | |
| 2845 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 2846 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 2847 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 2848 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 2849 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
| 2850 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
| 2851 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
| 2852 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 2853 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 2854 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 2855 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | |
| 2856 | <span class="hljs-attr">"account"</span>: { | |
| 2857 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 2858 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 2859 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 2860 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 2861 | <span class="hljs-attr">"avatar"</span>: { | |
| 2862 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 2863 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 2864 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 2865 | } | |
| 2866 | } | |
| 2867 | } | |
| 5e1c08eb C |
2868 | </code></pre> |
| 2869 | <!-- </div> --> | |
| 2870 | </section> | |
| 2871 | </div> | |
| 2872 | </div> | |
| 2873 | </div> | |
| 2963c343 | 2874 | <div id="operation--videos--id--delete" class="operation panel" data-traverse-target="operation--videos--id--delete"> |
| 5e1c08eb C |
2875 | <!-- <section class="operation-tags row"> --> |
| 2876 | <!-- <div class="doc-copy"> --> | |
| 2877 | <div class="operation-tags"> | |
| 2878 | <a class="label" href="#tag-Video">Video</a> | |
| 2879 | <!----> | |
| 2880 | </div> | |
| 2881 | <!-- </div> --> | |
| 2882 | <!-- </section> --> | |
| 2883 | <h2 class="operation-title"> | |
| 2963c343 | 2884 | <span class="operation-summary">Delete a video by its id</span> |
| 5e1c08eb C |
2885 | </h2> |
| 2886 | <div class="doc-row"> | |
| 2963c343 RK |
2887 | <div class="doc-copy"> |
| 2888 | <section class="swagger-operation-path"> | |
| 2889 | <span class="operation-method">DELETE</span> | |
| 2890 | <span class="operation-path">/videos/{id}</span> | |
| 2891 | </section> | |
| 2892 | </div> | |
| 5e1c08eb C |
2893 | </div> |
| 2894 | <div class="doc-row"> | |
| 2895 | <div class="doc-copy"> | |
| 2963c343 | 2896 | <section class="swagger-request-params"> |
| 5e1c08eb C |
2897 | <div class="prop-row prop-group"> |
| 2898 | <div class="prop-name"> | |
| 2963c343 RK |
2899 | <div class="prop-title">id: |
| 2900 | <span class="prop-type"> | |
| 2901 | <span class="json-property-type">string</span> | |
| 2902 | <span class="json-property-range" title="Value limits"></span> | |
| 2903 | </span> | |
| 2904 | </div> | |
| 2905 | <span class="json-property-required"></span> | |
| 2906 | <div class="prop-subtitle"> in path </div> | |
| 5e1c08eb C |
2907 | </div> |
| 2908 | <div class="prop-value"> | |
| 2963c343 | 2909 | <p>The video id or uuid</p> |
| 5e1c08eb C |
2910 | </div> |
| 2911 | </div> | |
| 2963c343 RK |
2912 | </section> |
| 2913 | </div> | |
| 2914 | <div class="doc-examples"></div> | |
| 2915 | </div> | |
| 2916 | <div class="doc-row"> | |
| 2917 | <div class="doc-copy"> | |
| 2918 | <section class="swagger-responses"> | |
| 2919 | <div class="prop-row prop-group"> | |
| 2920 | <div class="prop-name"> | |
| 2921 | <div class="prop-title">204 No Content</div> | |
| 2922 | </div> | |
| 228e84aa | 2923 | <div class="prop-value"> |
| 2963c343 | 2924 | <p>Successful operation</p> |
| 228e84aa C |
2925 | </div> |
| 2926 | </div> | |
| 5e1c08eb C |
2927 | </section> |
| 2928 | </div> | |
| 2929 | <div class="doc-examples"> | |
| 2930 | <h5>Response Content-Types: | |
| 2931 | <span>application/json</span> | |
| 2932 | </h5> | |
| 2963c343 RK |
2933 | </div> |
| 2934 | </div> | |
| 2935 | <div class="doc-row"> | |
| 2936 | <div class="doc-copy"> | |
| 2937 | <section class="swagger-request-security"> | |
| 2938 | <table class="table"> | |
| 2939 | <thead> | |
| 2940 | <tr> | |
| 2941 | <th class="swagger-request-security-schema"></th> | |
| 2942 | <th class="swagger-request-security-scopes"></th> | |
| 2943 | </tr> | |
| 2944 | </thead> | |
| 2945 | <tbody> | |
| 2946 | <tr> | |
| 2947 | <td> | |
| 2948 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 2949 | </td> | |
| 2950 | <td> </td> | |
| 2951 | </tr> | |
| 2952 | </tbody> | |
| 2953 | </table> | |
| 5e1c08eb C |
2954 | </section> |
| 2955 | </div> | |
| 2956 | </div> | |
| 2957 | </div> | |
| 2963c343 | 2958 | <div id="operation--videos--id--description-get" class="operation panel" data-traverse-target="operation--videos--id--description-get"> |
| 5e1c08eb C |
2959 | <!-- <section class="operation-tags row"> --> |
| 2960 | <!-- <div class="doc-copy"> --> | |
| 2961 | <div class="operation-tags"> | |
| 2962 | <a class="label" href="#tag-Video">Video</a> | |
| 2963 | <!----> | |
| 2964 | </div> | |
| 2965 | <!-- </div> --> | |
| 2966 | <!-- </section> --> | |
| 2967 | <h2 class="operation-title"> | |
| 2963c343 | 2968 | <span class="operation-summary">Get a video description by its id</span> |
| 5e1c08eb C |
2969 | </h2> |
| 2970 | <div class="doc-row"> | |
| 2963c343 RK |
2971 | <div class="doc-copy"> |
| 2972 | <section class="swagger-operation-path"> | |
| 2973 | <span class="operation-method">GET</span> | |
| 2974 | <span class="operation-path">/videos/{id}/description</span> | |
| 2975 | </section> | |
| 2976 | </div> | |
| 2977 | </div> | |
| 2978 | <div class="doc-row"> | |
| 2979 | <div class="doc-copy"> | |
| 2980 | <section class="swagger-request-params"> | |
| 2981 | <div class="prop-row prop-group"> | |
| 2982 | <div class="prop-name"> | |
| 2983 | <div class="prop-title">id: | |
| 2984 | <span class="prop-type"> | |
| 2985 | <span class="json-property-type">string</span> | |
| 2986 | <span class="json-property-range" title="Value limits"></span> | |
| 2987 | </span> | |
| 2988 | </div> | |
| 2989 | <span class="json-property-required"></span> | |
| 2990 | <div class="prop-subtitle"> in path </div> | |
| 2991 | </div> | |
| 2992 | <div class="prop-value"> | |
| 2993 | <p>The video id or uuid</p> | |
| 2994 | </div> | |
| 2995 | </div> | |
| 2996 | </section> | |
| 2997 | </div> | |
| 5e1c08eb C |
2998 | <div class="doc-examples"></div> |
| 2999 | </div> | |
| 3000 | <div class="doc-row"> | |
| 3001 | <div class="doc-copy"> | |
| 3002 | <section class="swagger-responses"> | |
| 3003 | <div class="prop-row prop-group"> | |
| 3004 | <div class="prop-name"> | |
| 3005 | <div class="prop-title">200 OK</div> | |
| 2963c343 | 3006 | <div class="prop-ref"></div> |
| 5e1c08eb C |
3007 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> |
| 3008 | </div> | |
| 3009 | <div class="prop-value"> | |
| 3010 | <p>successful operation</p> | |
| 3011 | </div> | |
| 3012 | </div> | |
| 228e84aa C |
3013 | <div class="prop-row prop-inner"> |
| 3014 | <div class="prop-name">type</div> | |
| 3015 | <div class="prop-value"> | |
| 2963c343 | 3016 | <span class="json-property-type">string</span> |
| 228e84aa C |
3017 | <span class="json-property-range" title="Value limits"></span> |
| 3018 | </div> | |
| 3019 | </div> | |
| 5e1c08eb C |
3020 | </section> |
| 3021 | </div> | |
| 3022 | <div class="doc-examples"> | |
| 3023 | <h5>Response Content-Types: | |
| 3024 | <span>application/json</span> | |
| 3025 | </h5> | |
| 3026 | <section> | |
| 3027 | <h5>Response Example | |
| 3028 | <span>(200 OK)</span> | |
| 3029 | </h5> | |
| 2963c343 | 3030 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">"string"</span> |
| 5e1c08eb C |
3031 | </code></pre> |
| 3032 | <!-- </div> --> | |
| 3033 | </section> | |
| 3034 | </div> | |
| 3035 | </div> | |
| 3036 | </div> | |
| 2963c343 | 3037 | <div id="operation--videos--id--views-post" class="operation panel" data-traverse-target="operation--videos--id--views-post"> |
| 5e1c08eb C |
3038 | <!-- <section class="operation-tags row"> --> |
| 3039 | <!-- <div class="doc-copy"> --> | |
| 3040 | <div class="operation-tags"> | |
| 3041 | <a class="label" href="#tag-Video">Video</a> | |
| 3042 | <!----> | |
| 3043 | </div> | |
| 3044 | <!-- </div> --> | |
| 3045 | <!-- </section> --> | |
| 3046 | <h2 class="operation-title"> | |
| 2963c343 | 3047 | <span class="operation-summary">Add a view to the video by its id</span> |
| 5e1c08eb | 3048 | </h2> |
| 2963c343 RK |
3049 | <div class="doc-row"> |
| 3050 | <div class="doc-copy"> | |
| 3051 | <section class="swagger-operation-path"> | |
| 3052 | <span class="operation-method">POST</span> | |
| 3053 | <span class="operation-path">/videos/{id}/views</span> | |
| 3054 | </section> | |
| 3055 | </div> | |
| 3056 | </div> | |
| 5e1c08eb C |
3057 | <div class="doc-row"> |
| 3058 | <div class="doc-copy"> | |
| 3059 | <section class="swagger-request-params"> | |
| 3060 | <div class="prop-row prop-group"> | |
| 3061 | <div class="prop-name"> | |
| 330eaf12 C |
3062 | <div class="prop-title">id: |
| 3063 | <span class="prop-type"> | |
| 3064 | <span class="json-property-type">string</span> | |
| 3065 | <span class="json-property-range" title="Value limits"></span> | |
| 3066 | </span> | |
| 3067 | </div> | |
| 5e1c08eb | 3068 | <span class="json-property-required"></span> |
| 228e84aa | 3069 | <div class="prop-subtitle"> in path </div> |
| 5e1c08eb C |
3070 | </div> |
| 3071 | <div class="prop-value"> | |
| 330eaf12 | 3072 | <p>The video id or uuid</p> |
| 5e1c08eb C |
3073 | </div> |
| 3074 | </div> | |
| 2963c343 RK |
3075 | </section> |
| 3076 | </div> | |
| 3077 | <div class="doc-examples"></div> | |
| 3078 | </div> | |
| 3079 | <div class="doc-row"> | |
| 3080 | <div class="doc-copy"> | |
| 3081 | <section class="swagger-responses"> | |
| 3082 | <div class="prop-row prop-group"> | |
| 3083 | <div class="prop-name"> | |
| 3084 | <div class="prop-title">204 No Content</div> | |
| 3085 | </div> | |
| 3086 | <div class="prop-value"> | |
| 3087 | <p>Successful operation</p> | |
| 3088 | </div> | |
| 3089 | </div> | |
| 3090 | </section> | |
| 3091 | </div> | |
| 3092 | <div class="doc-examples"> | |
| 3093 | <h5>Response Content-Types: | |
| 3094 | <span>application/json</span> | |
| 3095 | </h5> | |
| 3096 | </div> | |
| 3097 | </div> | |
| 3098 | </div> | |
| 3099 | <div id="operation--videos-upload-post" class="operation panel" data-traverse-target="operation--videos-upload-post"> | |
| 3100 | <!-- <section class="operation-tags row"> --> | |
| 3101 | <!-- <div class="doc-copy"> --> | |
| 3102 | <div class="operation-tags"> | |
| 3103 | <a class="label" href="#tag-Video">Video</a> | |
| 3104 | <!----> | |
| 3105 | </div> | |
| 3106 | <!-- </div> --> | |
| 3107 | <!-- </section> --> | |
| 3108 | <h2 class="operation-title"> | |
| 3109 | <span class="operation-summary">Upload a video file with its metadata</span> | |
| 3110 | </h2> | |
| 3111 | <div class="doc-row"> | |
| 3112 | <div class="doc-copy"> | |
| 3113 | <section class="swagger-operation-path"> | |
| 3114 | <span class="operation-method">POST</span> | |
| 3115 | <span class="operation-path">/videos/upload</span> | |
| 3116 | </section> | |
| 3117 | </div> | |
| 3118 | </div> | |
| 3119 | <div class="doc-row"> | |
| 3120 | <div class="doc-copy"> | |
| 3121 | <section class="swagger-request-params"> | |
| 3122 | <div class="prop-row prop-group"> | |
| 3123 | <div class="prop-name"> | |
| 3124 | <div class="prop-title">videofile: | |
| 3125 | <span class="prop-type"> | |
| 3126 | <span class="json-property-type">file</span> | |
| 3127 | <span class="json-property-range" title="Value limits"></span> | |
| 3128 | </span> | |
| 3129 | </div> | |
| 3130 | <span class="json-property-required"></span> | |
| 3131 | <div class="prop-subtitle"> in formData </div> | |
| 3132 | </div> | |
| 3133 | <div class="prop-value"> | |
| 3134 | <p>Video file</p> | |
| 3135 | </div> | |
| 3136 | </div> | |
| 3137 | <div class="prop-row prop-group"> | |
| 3138 | <div class="prop-name"> | |
| 3139 | <div class="prop-title">channelId: | |
| 3140 | <span class="prop-type"> | |
| 3141 | <span class="json-property-type">number</span> | |
| 3142 | <span class="json-property-range" title="Value limits"></span> | |
| 3143 | </span> | |
| 3144 | </div> | |
| 3145 | <span class="json-property-required"></span> | |
| 3146 | <div class="prop-subtitle"> in formData </div> | |
| 3147 | </div> | |
| 3148 | <div class="prop-value"> | |
| 3149 | <p>Channel id that will contain this video</p> | |
| 3150 | </div> | |
| 3151 | </div> | |
| 5e1c08eb C |
3152 | <div class="prop-row prop-group"> |
| 3153 | <div class="prop-name"> | |
| 330eaf12 C |
3154 | <div class="prop-title">thumbnailfile: |
| 3155 | <span class="prop-type"> | |
| 3156 | <span class="json-property-type">file</span> | |
| 3157 | <span class="json-property-range" title="Value limits"></span> | |
| 3158 | </span> | |
| 228e84aa | 3159 | </div> |
| 330eaf12 | 3160 | <div class="prop-subtitle"> in formData </div> |
| 5e1c08eb C |
3161 | </div> |
| 3162 | <div class="prop-value"> | |
| 61b66b36 | 3163 | <p>Video thumbnail file</p> |
| 5e1c08eb C |
3164 | </div> |
| 3165 | </div> | |
| 5e1c08eb C |
3166 | <div class="prop-row prop-group"> |
| 3167 | <div class="prop-name"> | |
| 330eaf12 C |
3168 | <div class="prop-title">previewfile: |
| 3169 | <span class="prop-type"> | |
| 3170 | <span class="json-property-type">file</span> | |
| 3171 | <span class="json-property-range" title="Value limits"></span> | |
| 3172 | </span> | |
| 228e84aa | 3173 | </div> |
| 330eaf12 | 3174 | <div class="prop-subtitle"> in formData </div> |
| 5e1c08eb C |
3175 | </div> |
| 3176 | <div class="prop-value"> | |
| 61b66b36 | 3177 | <p>Video preview file</p> |
| 5e1c08eb C |
3178 | </div> |
| 3179 | </div> | |
| 5e1c08eb C |
3180 | <div class="prop-row prop-group"> |
| 3181 | <div class="prop-name"> | |
| 330eaf12 C |
3182 | <div class="prop-title">category: |
| 3183 | <span class="prop-type"> | |
| 3184 | <span class="json-property-type">number</span> | |
| 3185 | <span class="json-property-range" title="Value limits"></span> | |
| 3186 | </span> | |
| 228e84aa | 3187 | </div> |
| 330eaf12 | 3188 | <div class="prop-subtitle"> in formData </div> |
| 5e1c08eb C |
3189 | </div> |
| 3190 | <div class="prop-value"> | |
| 61b66b36 | 3191 | <p>Video category</p> |
| 5e1c08eb C |
3192 | </div> |
| 3193 | </div> | |
| 5e1c08eb C |
3194 | <div class="prop-row prop-group"> |
| 3195 | <div class="prop-name"> | |
| 330eaf12 C |
3196 | <div class="prop-title">licence: |
| 3197 | <span class="prop-type"> | |
| 3198 | <span class="json-property-type">number</span> | |
| 3199 | <span class="json-property-range" title="Value limits"></span> | |
| 3200 | </span> | |
| 228e84aa | 3201 | </div> |
| 330eaf12 | 3202 | <div class="prop-subtitle"> in formData </div> |
| 5e1c08eb C |
3203 | </div> |
| 3204 | <div class="prop-value"> | |
| 61b66b36 | 3205 | <p>Video licence</p> |
| 5e1c08eb C |
3206 | </div> |
| 3207 | </div> | |
| 61b66b36 C |
3208 | <div class="prop-row prop-group"> |
| 3209 | <div class="prop-name"> | |
| 330eaf12 C |
3210 | <div class="prop-title">language: |
| 3211 | <span class="prop-type"> | |
| 3212 | <span class="json-property-type">string</span> | |
| 3213 | <span class="json-property-range" title="Value limits"></span> | |
| 3214 | </span> | |
| 228e84aa | 3215 | </div> |
| 330eaf12 | 3216 | <div class="prop-subtitle"> in formData </div> |
| 61b66b36 C |
3217 | </div> |
| 3218 | <div class="prop-value"> | |
| 3219 | <p>Video language</p> | |
| 3220 | </div> | |
| 3221 | </div> | |
| 61b66b36 C |
3222 | <div class="prop-row prop-group"> |
| 3223 | <div class="prop-name"> | |
| 330eaf12 C |
3224 | <div class="prop-title">description: |
| 3225 | <span class="prop-type"> | |
| 3226 | <span class="json-property-type">string</span> | |
| 3227 | <span class="json-property-range" title="Value limits"></span> | |
| 3228 | </span> | |
| 228e84aa | 3229 | </div> |
| 330eaf12 | 3230 | <div class="prop-subtitle"> in formData </div> |
| 61b66b36 C |
3231 | </div> |
| 3232 | <div class="prop-value"> | |
| 3233 | <p>Video description</p> | |
| 3234 | </div> | |
| 3235 | </div> | |
| 2186386c C |
3236 | <div class="prop-row prop-group"> |
| 3237 | <div class="prop-name"> | |
| 330eaf12 C |
3238 | <div class="prop-title">waitTranscoding: |
| 3239 | <span class="prop-type"> | |
| 3240 | <span class="json-property-type">boolean</span> | |
| 3241 | <span class="json-property-range" title="Value limits"></span> | |
| 3242 | </span> | |
| 2186386c | 3243 | </div> |
| 330eaf12 | 3244 | <div class="prop-subtitle"> in formData </div> |
| 2186386c C |
3245 | </div> |
| 3246 | <div class="prop-value"> | |
| 3247 | <p>Whether or not we wait transcoding before publish the video</p> | |
| 3248 | </div> | |
| 3249 | </div> | |
| 61b66b36 C |
3250 | <div class="prop-row prop-group"> |
| 3251 | <div class="prop-name"> | |
| 330eaf12 C |
3252 | <div class="prop-title">support: |
| 3253 | <span class="prop-type"> | |
| 3254 | <span class="json-property-type">string</span> | |
| 3255 | <span class="json-property-range" title="Value limits"></span> | |
| 3256 | </span> | |
| 228e84aa | 3257 | </div> |
| 330eaf12 | 3258 | <div class="prop-subtitle"> in formData </div> |
| 61b66b36 C |
3259 | </div> |
| 3260 | <div class="prop-value"> | |
| 3261 | <p>Text describing how to support the video uploader</p> | |
| 3262 | </div> | |
| 3263 | </div> | |
| 61b66b36 C |
3264 | <div class="prop-row prop-group"> |
| 3265 | <div class="prop-name"> | |
| 330eaf12 C |
3266 | <div class="prop-title">nsfw: |
| 3267 | <span class="prop-type"> | |
| 3268 | <span class="json-property-type">boolean</span> | |
| 3269 | <span class="json-property-range" title="Value limits"></span> | |
| 3270 | </span> | |
| 228e84aa | 3271 | </div> |
| 330eaf12 | 3272 | <div class="prop-subtitle"> in formData </div> |
| 61b66b36 C |
3273 | </div> |
| 3274 | <div class="prop-value"> | |
| 3275 | <p>Whether or not this video contains sensitive content</p> | |
| 3276 | </div> | |
| 3277 | </div> | |
| 61b66b36 C |
3278 | <div class="prop-row prop-group"> |
| 3279 | <div class="prop-name"> | |
| 330eaf12 C |
3280 | <div class="prop-title">name: |
| 3281 | <span class="prop-type"> | |
| 3282 | <span class="json-property-type">string</span> | |
| 3283 | <span class="json-property-range" title="Value limits"></span> | |
| 3284 | </span> | |
| 228e84aa | 3285 | </div> |
| 330eaf12 | 3286 | <div class="prop-subtitle"> in formData </div> |
| 61b66b36 C |
3287 | </div> |
| 3288 | <div class="prop-value"> | |
| 3289 | <p>Video name</p> | |
| 3290 | </div> | |
| 3291 | </div> | |
| 61b66b36 C |
3292 | <div class="prop-row prop-group"> |
| 3293 | <div class="prop-name"> | |
| 330eaf12 C |
3294 | <div class="prop-title">tags: |
| 3295 | <span class="prop-type"> | |
| 3296 | <span class="json-property-type">string[]</span> | |
| 3297 | <span class="json-property-range" title="Value limits"></span> | |
| 3298 | </span> | |
| 228e84aa | 3299 | </div> |
| 330eaf12 | 3300 | <div class="prop-subtitle"> in formData </div> |
| 61b66b36 C |
3301 | </div> |
| 3302 | <div class="prop-value"> | |
| 3303 | <p>Video tags</p> | |
| 3304 | </div> | |
| 3305 | </div> | |
| 61b66b36 C |
3306 | <div class="prop-row prop-group"> |
| 3307 | <div class="prop-name"> | |
| 330eaf12 C |
3308 | <div class="prop-title">commentsEnabled: |
| 3309 | <span class="prop-type"> | |
| 3310 | <span class="json-property-type">boolean</span> | |
| 3311 | <span class="json-property-range" title="Value limits"></span> | |
| 3312 | </span> | |
| 228e84aa | 3313 | </div> |
| 330eaf12 | 3314 | <div class="prop-subtitle"> in formData </div> |
| 61b66b36 C |
3315 | </div> |
| 3316 | <div class="prop-value"> | |
| 3317 | <p>Enable or disable comments for this video</p> | |
| 3318 | </div> | |
| 3319 | </div> | |
| 61b66b36 C |
3320 | <div class="prop-row prop-group"> |
| 3321 | <div class="prop-name"> | |
| 330eaf12 C |
3322 | <div class="prop-title">privacy: |
| 3323 | <span class="prop-type"> | |
| 3324 | <span class="json-property-type">string</span> | |
| 3325 | <span class="json-property-enum" title="Possible values"> | |
| 3326 | <span class="json-property-enum-item">Public</span>, | |
| 3327 | <span class="json-property-enum-item">Unlisted</span> | |
| 3328 | </span> | |
| 3329 | <span class="json-property-range" title="Value limits"></span> | |
| 228e84aa | 3330 | </span> |
| 228e84aa | 3331 | </div> |
| 330eaf12 | 3332 | <div class="prop-subtitle"> in formData </div> |
| 61b66b36 C |
3333 | </div> |
| 3334 | <div class="prop-value"> | |
| 3335 | <p>Video privacy</p> | |
| 3336 | </div> | |
| 3337 | </div> | |
| bbe0f064 C |
3338 | <div class="prop-row prop-group"> |
| 3339 | <div class="prop-name"> | |
| 330eaf12 C |
3340 | <div class="prop-title">scheduleUpdate: |
| 3341 | <span class="prop-type"> | |
| 3342 | <span class="json-property-type">object</span> | |
| 3343 | <span class="json-property-range" title="Value limits"></span> | |
| 3344 | </span> | |
| bbe0f064 | 3345 | </div> |
| 330eaf12 | 3346 | <div class="prop-subtitle"> in formData </div> |
| bbe0f064 C |
3347 | </div> |
| 3348 | <div class="prop-value"> | |
| 330eaf12 | 3349 | <p>Schedule an update at a specific datetime</p> |
| bbe0f064 C |
3350 | </div> |
| 3351 | </div> | |
| 61b66b36 C |
3352 | </section> |
| 3353 | </div> | |
| 3354 | <div class="doc-examples"></div> | |
| 3355 | </div> | |
| 3356 | <div class="doc-row"> | |
| 3357 | <div class="doc-copy"> | |
| 3358 | <section class="swagger-responses"> | |
| 3359 | <div class="prop-row prop-group"> | |
| 3360 | <div class="prop-name"> | |
| 3361 | <div class="prop-title">200 OK</div> | |
| 3362 | <div class="prop-ref"> | |
| 3363 | <span class=""> | |
| 2963c343 | 3364 | <a class="json-schema-ref" href="#/definitions/VideoUploadResponse">VideoUploadResponse</a> |
| 61b66b36 C |
3365 | </span> |
| 3366 | </div> | |
| 3367 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 3368 | </div> | |
| 3369 | <div class="prop-value"> | |
| 3370 | <p>successful operation</p> | |
| 3371 | </div> | |
| 3372 | </div> | |
| 3373 | </section> | |
| 3374 | </div> | |
| 3375 | <div class="doc-examples"> | |
| 3376 | <h5>Response Content-Types: | |
| 3377 | <span>application/json</span> | |
| 3378 | </h5> | |
| 3379 | <section> | |
| 3380 | <h5>Response Example | |
| 3381 | <span>(200 OK)</span> | |
| 3382 | </h5> | |
| 3383 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 2963c343 | 3384 | <span class="hljs-attr">"video"</span>: { |
| 61b66b36 | 3385 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, |
| 2963c343 | 3386 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> |
| 61b66b36 C |
3387 | } |
| 3388 | } | |
| 3389 | </code></pre> | |
| 3390 | <!-- </div> --> | |
| 3391 | </section> | |
| 3392 | </div> | |
| 3393 | </div> | |
| 94ff4c23 C |
3394 | <div class="doc-row"> |
| 3395 | <div class="doc-copy"> | |
| 3396 | <section class="swagger-request-security"> | |
| 3397 | <table class="table"> | |
| 3398 | <thead> | |
| 3399 | <tr> | |
| 3400 | <th class="swagger-request-security-schema"></th> | |
| 3401 | <th class="swagger-request-security-scopes"></th> | |
| 3402 | </tr> | |
| 3403 | </thead> | |
| 3404 | <tbody> | |
| 3405 | <tr> | |
| 3406 | <td> | |
| 3407 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 3408 | </td> | |
| 3409 | <td> </td> | |
| 3410 | </tr> | |
| 3411 | </tbody> | |
| 3412 | </table> | |
| 3413 | </section> | |
| 3414 | </div> | |
| 3415 | </div> | |
| 61b66b36 | 3416 | </div> |
| 2963c343 RK |
3417 | <h1 id="tag-Search" class="swagger-summary-tag" data-traverse-target="tag-Search">Search</h1> |
| 3418 | <div class="tag-description doc-row"> | |
| 3419 | <div class="doc-copy"> | |
| 3420 | <p>The search helps to find | |
| 3421 | <em>videos</em> from within the instance and beyond. Videos from other instances federated by the instance (that is, instances followed by the instance) can be found via keywords and other criteria of the advanced search.</p> | |
| 3422 | </div> | |
| 3423 | </div> | |
| 3424 | <div id="operation--search-videos-get" class="operation panel" data-traverse-target="operation--search-videos-get"> | |
| 61b66b36 C |
3425 | <!-- <section class="operation-tags row"> --> |
| 3426 | <!-- <div class="doc-copy"> --> | |
| 3427 | <div class="operation-tags"> | |
| 2963c343 | 3428 | <a class="label" href="#tag-Search">Search</a> |
| 61b66b36 C |
3429 | <!----> |
| 3430 | </div> | |
| 3431 | <!-- </div> --> | |
| 3432 | <!-- </section> --> | |
| 3433 | <h2 class="operation-title"> | |
| 2963c343 | 3434 | <span class="operation-summary">Get the videos corresponding to a given query</span> |
| 61b66b36 | 3435 | </h2> |
| 2963c343 RK |
3436 | <div class="doc-row"> |
| 3437 | <div class="doc-copy"> | |
| 3438 | <section class="swagger-operation-path"> | |
| 3439 | <span class="operation-method">GET</span> | |
| 3440 | <span class="operation-path">/search/videos</span> | |
| 3441 | </section> | |
| 3442 | </div> | |
| 3443 | </div> | |
| 61b66b36 C |
3444 | <div class="doc-row"> |
| 3445 | <div class="doc-copy"> | |
| 3446 | <section class="swagger-request-params"> | |
| 3447 | <div class="prop-row prop-group"> | |
| 3448 | <div class="prop-name"> | |
| 2963c343 RK |
3449 | <div class="prop-title">start: |
| 3450 | <span class="prop-type"> | |
| 3451 | <span class="json-property-type">number</span> | |
| 3452 | <span class="json-property-range" title="Value limits"></span> | |
| 3453 | </span> | |
| 3454 | </div> | |
| 3455 | <div class="prop-subtitle"> in query </div> | |
| 3456 | </div> | |
| 3457 | <div class="prop-value"> | |
| 3458 | <p>Offset</p> | |
| 3459 | </div> | |
| 3460 | </div> | |
| 3461 | <div class="prop-row prop-group"> | |
| 3462 | <div class="prop-name"> | |
| 3463 | <div class="prop-title">count: | |
| 3464 | <span class="prop-type"> | |
| 3465 | <span class="json-property-type">number</span> | |
| 3466 | <span class="json-property-range" title="Value limits"></span> | |
| 3467 | </span> | |
| 3468 | </div> | |
| 3469 | <div class="prop-subtitle"> in query </div> | |
| 3470 | </div> | |
| 3471 | <div class="prop-value"> | |
| 3472 | <p>Number of items</p> | |
| 3473 | </div> | |
| 3474 | </div> | |
| 3475 | <div class="prop-row prop-group"> | |
| 3476 | <div class="prop-name"> | |
| 3477 | <div class="prop-title">sort: | |
| 3478 | <span class="prop-type"> | |
| 3479 | <span class="json-property-type">string</span> | |
| 3480 | <span class="json-property-range" title="Value limits"></span> | |
| 3481 | </span> | |
| 3482 | </div> | |
| 3483 | <div class="prop-subtitle"> in query </div> | |
| 3484 | </div> | |
| 3485 | <div class="prop-value"> | |
| 3486 | <p>Sort column (-createdAt for example)</p> | |
| 3487 | </div> | |
| 3488 | </div> | |
| 3489 | <div class="prop-row prop-group"> | |
| 3490 | <div class="prop-name"> | |
| 3491 | <div class="prop-title">search: | |
| 330eaf12 C |
3492 | <span class="prop-type"> |
| 3493 | <span class="json-property-type">string</span> | |
| 3494 | <span class="json-property-range" title="Value limits"></span> | |
| 3495 | </span> | |
| 3496 | </div> | |
| 61b66b36 | 3497 | <span class="json-property-required"></span> |
| 2963c343 | 3498 | <div class="prop-subtitle"> in query </div> |
| 61b66b36 C |
3499 | </div> |
| 3500 | <div class="prop-value"> | |
| 2963c343 | 3501 | <p>String to search</p> |
| 61b66b36 C |
3502 | </div> |
| 3503 | </div> | |
| 61b66b36 C |
3504 | </section> |
| 3505 | </div> | |
| 3506 | <div class="doc-examples"></div> | |
| 3507 | </div> | |
| 3508 | <div class="doc-row"> | |
| 3509 | <div class="doc-copy"> | |
| 3510 | <section class="swagger-responses"> | |
| 3511 | <div class="prop-row prop-group"> | |
| 3512 | <div class="prop-name"> | |
| 3513 | <div class="prop-title">200 OK</div> | |
| 3514 | <div class="prop-ref"> | |
| 2963c343 | 3515 | <span class="json-schema-ref-array"> |
| 61b66b36 C |
3516 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> |
| 3517 | </span> | |
| 3518 | </div> | |
| 3519 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 3520 | </div> | |
| 3521 | <div class="prop-value"> | |
| 3522 | <p>successful operation</p> | |
| 3523 | </div> | |
| 3524 | </div> | |
| 2963c343 RK |
3525 | <div class="prop-row prop-inner"> |
| 3526 | <div class="prop-name">type</div> | |
| 3527 | <div class="prop-value"> | |
| 3528 | <span class="json-property-type"> | |
| 3529 | <span class="json-schema-ref-array"> | |
| 3530 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
| 3531 | </span> | |
| 3532 | </span> | |
| 3533 | <span class="json-property-range" title="Value limits"></span> | |
| 3534 | </div> | |
| 3535 | </div> | |
| 61b66b36 C |
3536 | </section> |
| 3537 | </div> | |
| 3538 | <div class="doc-examples"> | |
| 3539 | <h5>Response Content-Types: | |
| 3540 | <span>application/json</span> | |
| 3541 | </h5> | |
| 3542 | <section> | |
| 3543 | <h5>Response Example | |
| 3544 | <span>(200 OK)</span> | |
| 3545 | </h5> | |
| 2963c343 RK |
3546 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ |
| 3547 | { | |
| 61b66b36 | 3548 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, |
| 2963c343 RK |
3549 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, |
| 3550 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3551 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3552 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3553 | <span class="hljs-attr">"category"</span>: { | |
| 3554 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 3555 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 3556 | }, | |
| 3557 | <span class="hljs-attr">"licence"</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">"language"</span>: { | |
| 3562 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
| 3563 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 3564 | }, | |
| 3565 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | |
| 3566 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 3567 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 3568 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 61b66b36 | 3569 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, |
| 2963c343 RK |
3570 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
| 3571 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
| 3572 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
| 3573 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 3574 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 3575 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 3576 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | |
| 3577 | <span class="hljs-attr">"account"</span>: { | |
| 3578 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 3579 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 3580 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 3581 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 3582 | <span class="hljs-attr">"avatar"</span>: { | |
| 3583 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 3584 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3585 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 3586 | } | |
| 3587 | } | |
| 3588 | } | |
| 3589 | ] | |
| 3590 | </code></pre> | |
| 61b66b36 C |
3591 | <!-- </div> --> |
| 3592 | </section> | |
| 3593 | </div> | |
| 3594 | </div> | |
| 3595 | </div> | |
| 2963c343 RK |
3596 | <h1 id="tag-VideoComment" class="swagger-summary-tag" data-traverse-target="tag-VideoComment">VideoComment</h1> |
| 3597 | <div class="tag-description doc-row"> | |
| 3598 | <div class="doc-copy"> | |
| 3599 | <p>Operations dealing with comments to a video. Comments are organized in threads.</p> | |
| 3600 | </div> | |
| 3601 | </div> | |
| 3602 | <div id="operation--videos--id--comment-threads-get" class="operation panel" data-traverse-target="operation--videos--id--comment-threads-get"> | |
| 61b66b36 C |
3603 | <!-- <section class="operation-tags row"> --> |
| 3604 | <!-- <div class="doc-copy"> --> | |
| 3605 | <div class="operation-tags"> | |
| 2963c343 | 3606 | <a class="label" href="#tag-VideoComment">VideoComment</a> |
| 61b66b36 C |
3607 | <!----> |
| 3608 | </div> | |
| 3609 | <!-- </div> --> | |
| 3610 | <!-- </section> --> | |
| 3611 | <h2 class="operation-title"> | |
| 2963c343 | 3612 | <span class="operation-summary">Get the comment threads of a video by its id</span> |
| 61b66b36 | 3613 | </h2> |
| 2963c343 RK |
3614 | <div class="doc-row"> |
| 3615 | <div class="doc-copy"> | |
| 3616 | <section class="swagger-operation-path"> | |
| 3617 | <span class="operation-method">GET</span> | |
| 3618 | <span class="operation-path">/videos/{id}/comment-threads</span> | |
| 3619 | </section> | |
| 3620 | </div> | |
| 3621 | </div> | |
| 61b66b36 C |
3622 | <div class="doc-row"> |
| 3623 | <div class="doc-copy"> | |
| 3624 | <section class="swagger-request-params"> | |
| 3625 | <div class="prop-row prop-group"> | |
| 3626 | <div class="prop-name"> | |
| 330eaf12 C |
3627 | <div class="prop-title">id: |
| 3628 | <span class="prop-type"> | |
| 3629 | <span class="json-property-type">string</span> | |
| 3630 | <span class="json-property-range" title="Value limits"></span> | |
| 3631 | </span> | |
| 3632 | </div> | |
| 61b66b36 | 3633 | <span class="json-property-required"></span> |
| 228e84aa | 3634 | <div class="prop-subtitle"> in path </div> |
| 61b66b36 C |
3635 | </div> |
| 3636 | <div class="prop-value"> | |
| 330eaf12 | 3637 | <p>The video id or uuid</p> |
| 61b66b36 C |
3638 | </div> |
| 3639 | </div> | |
| 61b66b36 C |
3640 | <div class="prop-row prop-group"> |
| 3641 | <div class="prop-name"> | |
| 2963c343 RK |
3642 | <div class="prop-title">start: |
| 3643 | <span class="prop-type"> | |
| 3644 | <span class="json-property-type">number</span> | |
| 3645 | <span class="json-property-range" title="Value limits"></span> | |
| 3646 | </span> | |
| 3647 | </div> | |
| 3648 | <div class="prop-subtitle"> in query </div> | |
| 61b66b36 C |
3649 | </div> |
| 3650 | <div class="prop-value"> | |
| 2963c343 | 3651 | <p>Offset</p> |
| 61b66b36 C |
3652 | </div> |
| 3653 | </div> | |
| 61b66b36 C |
3654 | <div class="prop-row prop-group"> |
| 3655 | <div class="prop-name"> | |
| 2963c343 RK |
3656 | <div class="prop-title">count: |
| 3657 | <span class="prop-type"> | |
| 3658 | <span class="json-property-type">number</span> | |
| 3659 | <span class="json-property-range" title="Value limits"></span> | |
| 3660 | </span> | |
| 3661 | </div> | |
| 3662 | <div class="prop-subtitle"> in query </div> | |
| 3663 | </div> | |
| 3664 | <div class="prop-value"> | |
| 3665 | <p>Number of items</p> | |
| 3666 | </div> | |
| 3667 | </div> | |
| 3668 | <div class="prop-row prop-group"> | |
| 3669 | <div class="prop-name"> | |
| 3670 | <div class="prop-title">sort: | |
| 330eaf12 C |
3671 | <span class="prop-type"> |
| 3672 | <span class="json-property-type">string</span> | |
| 3673 | <span class="json-property-range" title="Value limits"></span> | |
| 3674 | </span> | |
| 3675 | </div> | |
| 2963c343 | 3676 | <div class="prop-subtitle"> in query </div> |
| 61b66b36 C |
3677 | </div> |
| 3678 | <div class="prop-value"> | |
| 2963c343 | 3679 | <p>Sort column (-createdAt for example)</p> |
| 61b66b36 C |
3680 | </div> |
| 3681 | </div> | |
| 61b66b36 C |
3682 | </section> |
| 3683 | </div> | |
| 3684 | <div class="doc-examples"></div> | |
| 3685 | </div> | |
| 3686 | <div class="doc-row"> | |
| 3687 | <div class="doc-copy"> | |
| 3688 | <section class="swagger-responses"> | |
| 3689 | <div class="prop-row prop-group"> | |
| 3690 | <div class="prop-name"> | |
| 3691 | <div class="prop-title">200 OK</div> | |
| 2963c343 RK |
3692 | <div class="prop-ref"> |
| 3693 | <span class=""> | |
| 3694 | <a class="json-schema-ref" href="#/definitions/CommentThreadResponse">CommentThreadResponse</a> | |
| 3695 | </span> | |
| 3696 | </div> | |
| 61b66b36 C |
3697 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> |
| 3698 | </div> | |
| 3699 | <div class="prop-value"> | |
| 3700 | <p>successful operation</p> | |
| 3701 | </div> | |
| 3702 | </div> | |
| 3703 | </section> | |
| 3704 | </div> | |
| 3705 | <div class="doc-examples"> | |
| 3706 | <h5>Response Content-Types: | |
| 3707 | <span>application/json</span> | |
| 3708 | </h5> | |
| 3709 | <section> | |
| 3710 | <h5>Response Example | |
| 3711 | <span>(200 OK)</span> | |
| 3712 | </h5> | |
| 2963c343 RK |
3713 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ |
| 3714 | <span class="hljs-attr">"total"</span>: <span class="hljs-string">"number"</span>, | |
| 3715 | <span class="hljs-attr">"data"</span>: [ | |
| 3716 | { | |
| 3717 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 3718 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 3719 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 3720 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 3721 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 3722 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 3723 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3724 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3725 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 3726 | <span class="hljs-attr">"account"</span>: { | |
| 3727 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 3728 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 3729 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 3730 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 3731 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 3732 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 3733 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 3734 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 3735 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3736 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3737 | <span class="hljs-attr">"avatar"</span>: { | |
| 3738 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 3739 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3740 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 3741 | } | |
| 3742 | } | |
| 3743 | } | |
| 3744 | ] | |
| 3745 | } | |
| 61b66b36 C |
3746 | </code></pre> |
| 3747 | <!-- </div> --> | |
| 3748 | </section> | |
| 3749 | </div> | |
| 3750 | </div> | |
| 3751 | </div> | |
| 2963c343 | 3752 | <div id="operation--videos--id--comment-threads-post" class="operation panel" data-traverse-target="operation--videos--id--comment-threads-post"> |
| 61b66b36 C |
3753 | <!-- <section class="operation-tags row"> --> |
| 3754 | <!-- <div class="doc-copy"> --> | |
| 3755 | <div class="operation-tags"> | |
| 2963c343 | 3756 | <a class="label" href="#tag-VideoComment">VideoComment</a> |
| 61b66b36 C |
3757 | <!----> |
| 3758 | </div> | |
| 3759 | <!-- </div> --> | |
| 3760 | <!-- </section> --> | |
| 3761 | <h2 class="operation-title"> | |
| 2963c343 | 3762 | <span class="operation-summary">Creates a comment thread, on a video by its id</span> |
| 61b66b36 | 3763 | </h2> |
| 2963c343 RK |
3764 | <div class="doc-row"> |
| 3765 | <div class="doc-copy"> | |
| 3766 | <section class="swagger-operation-path"> | |
| 3767 | <span class="operation-method">POST</span> | |
| 3768 | <span class="operation-path">/videos/{id}/comment-threads</span> | |
| 3769 | </section> | |
| 3770 | </div> | |
| 3771 | </div> | |
| 61b66b36 C |
3772 | <div class="doc-row"> |
| 3773 | <div class="doc-copy"> | |
| 3774 | <section class="swagger-request-params"> | |
| 3775 | <div class="prop-row prop-group"> | |
| 3776 | <div class="prop-name"> | |
| 330eaf12 C |
3777 | <div class="prop-title">id: |
| 3778 | <span class="prop-type"> | |
| 3779 | <span class="json-property-type">string</span> | |
| 3780 | <span class="json-property-range" title="Value limits"></span> | |
| 3781 | </span> | |
| 3782 | </div> | |
| 61b66b36 | 3783 | <span class="json-property-required"></span> |
| 228e84aa | 3784 | <div class="prop-subtitle"> in path </div> |
| 61b66b36 C |
3785 | </div> |
| 3786 | <div class="prop-value"> | |
| 330eaf12 | 3787 | <p>The video id or uuid</p> |
| 61b66b36 C |
3788 | </div> |
| 3789 | </div> | |
| 5e1c08eb C |
3790 | </section> |
| 3791 | </div> | |
| 3792 | <div class="doc-examples"></div> | |
| 3793 | </div> | |
| 3794 | <div class="doc-row"> | |
| 3795 | <div class="doc-copy"> | |
| 3796 | <section class="swagger-responses"> | |
| 3797 | <div class="prop-row prop-group"> | |
| 3798 | <div class="prop-name"> | |
| 2963c343 RK |
3799 | <div class="prop-title">200 OK</div> |
| 3800 | <div class="prop-ref"> | |
| 3801 | <span class=""> | |
| 3802 | <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a> | |
| 3803 | </span> | |
| 3804 | </div> | |
| 3805 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 5e1c08eb C |
3806 | </div> |
| 3807 | <div class="prop-value"> | |
| 2963c343 | 3808 | <p>successful operation</p> |
| 5e1c08eb C |
3809 | </div> |
| 3810 | </div> | |
| 3811 | </section> | |
| 3812 | </div> | |
| 3813 | <div class="doc-examples"> | |
| 3814 | <h5>Response Content-Types: | |
| 3815 | <span>application/json</span> | |
| 3816 | </h5> | |
| 2963c343 RK |
3817 | <section> |
| 3818 | <h5>Response Example | |
| 3819 | <span>(200 OK)</span> | |
| 3820 | </h5> | |
| 3821 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 3822 | <span class="hljs-attr">"comment"</span>: { | |
| 3823 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 3824 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 3825 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 3826 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 3827 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 3828 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 3829 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3830 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3831 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 3832 | <span class="hljs-attr">"account"</span>: { | |
| 3833 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 3834 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 3835 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 3836 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 3837 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 3838 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 3839 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 3840 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 3841 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3842 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3843 | <span class="hljs-attr">"avatar"</span>: { | |
| 3844 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 3845 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3846 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 3847 | } | |
| 3848 | } | |
| 3849 | } | |
| 3850 | } | |
| 3851 | </code></pre> | |
| 3852 | <!-- </div> --> | |
| 3853 | </section> | |
| 3854 | </div> | |
| 3855 | </div> | |
| 3856 | <div class="doc-row"> | |
| 3857 | <div class="doc-copy"> | |
| 3858 | <section class="swagger-request-security"> | |
| 3859 | <table class="table"> | |
| 3860 | <thead> | |
| 3861 | <tr> | |
| 3862 | <th class="swagger-request-security-schema"></th> | |
| 3863 | <th class="swagger-request-security-scopes"></th> | |
| 3864 | </tr> | |
| 3865 | </thead> | |
| 3866 | <tbody> | |
| 3867 | <tr> | |
| 3868 | <td> | |
| 3869 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 3870 | </td> | |
| 3871 | <td> </td> | |
| 3872 | </tr> | |
| 3873 | </tbody> | |
| 3874 | </table> | |
| 3875 | </section> | |
| 5e1c08eb C |
3876 | </div> |
| 3877 | </div> | |
| 3878 | </div> | |
| 2963c343 | 3879 | <div id="operation--videos--id--comment-threads--threadId--get" class="operation panel" data-traverse-target="operation--videos--id--comment-threads--threadId--get"> |
| 5e1c08eb C |
3880 | <!-- <section class="operation-tags row"> --> |
| 3881 | <!-- <div class="doc-copy"> --> | |
| 3882 | <div class="operation-tags"> | |
| 2963c343 | 3883 | <a class="label" href="#tag-VideoComment">VideoComment</a> |
| 5e1c08eb C |
3884 | <!----> |
| 3885 | </div> | |
| 3886 | <!-- </div> --> | |
| 3887 | <!-- </section> --> | |
| 3888 | <h2 class="operation-title"> | |
| 2963c343 | 3889 | <span class="operation-summary">Get the comment thread by its id, of a video by its id</span> |
| 5e1c08eb | 3890 | </h2> |
| 2963c343 RK |
3891 | <div class="doc-row"> |
| 3892 | <div class="doc-copy"> | |
| 3893 | <section class="swagger-operation-path"> | |
| 3894 | <span class="operation-method">GET</span> | |
| 3895 | <span class="operation-path">/videos/{id}/comment-threads/{threadId}</span> | |
| 3896 | </section> | |
| 3897 | </div> | |
| 3898 | </div> | |
| 5e1c08eb C |
3899 | <div class="doc-row"> |
| 3900 | <div class="doc-copy"> | |
| 3901 | <section class="swagger-request-params"> | |
| 3902 | <div class="prop-row prop-group"> | |
| 3903 | <div class="prop-name"> | |
| 2963c343 | 3904 | <div class="prop-title">id: |
| 330eaf12 | 3905 | <span class="prop-type"> |
| 2963c343 | 3906 | <span class="json-property-type">string</span> |
| 330eaf12 C |
3907 | <span class="json-property-range" title="Value limits"></span> |
| 3908 | </span> | |
| 3909 | </div> | |
| 61b66b36 | 3910 | <span class="json-property-required"></span> |
| 2963c343 | 3911 | <div class="prop-subtitle"> in path </div> |
| 61b66b36 C |
3912 | </div> |
| 3913 | <div class="prop-value"> | |
| 2963c343 | 3914 | <p>The video id or uuid</p> |
| 61b66b36 C |
3915 | </div> |
| 3916 | </div> | |
| 61b66b36 C |
3917 | <div class="prop-row prop-group"> |
| 3918 | <div class="prop-name"> | |
| 2963c343 | 3919 | <div class="prop-title">threadId: |
| 330eaf12 C |
3920 | <span class="prop-type"> |
| 3921 | <span class="json-property-type">number</span> | |
| 3922 | <span class="json-property-range" title="Value limits"></span> | |
| 3923 | </span> | |
| 3924 | </div> | |
| 61b66b36 | 3925 | <span class="json-property-required"></span> |
| 2963c343 | 3926 | <div class="prop-subtitle"> in path </div> |
| 2186386c C |
3927 | </div> |
| 3928 | <div class="prop-value"> | |
| 2963c343 | 3929 | <p>The thread id (root comment id)</p> |
| 2186386c C |
3930 | </div> |
| 3931 | </div> | |
| 2963c343 RK |
3932 | </section> |
| 3933 | </div> | |
| 3934 | <div class="doc-examples"></div> | |
| 3935 | </div> | |
| 3936 | <div class="doc-row"> | |
| 3937 | <div class="doc-copy"> | |
| 3938 | <section class="swagger-responses"> | |
| 61b66b36 C |
3939 | <div class="prop-row prop-group"> |
| 3940 | <div class="prop-name"> | |
| 2963c343 RK |
3941 | <div class="prop-title">200 OK</div> |
| 3942 | <div class="prop-ref"> | |
| 3943 | <span class=""> | |
| 3944 | <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a> | |
| 330eaf12 | 3945 | </span> |
| 228e84aa | 3946 | </div> |
| 2963c343 | 3947 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> |
| 61b66b36 C |
3948 | </div> |
| 3949 | <div class="prop-value"> | |
| 2963c343 | 3950 | <p>successful operation</p> |
| 61b66b36 C |
3951 | </div> |
| 3952 | </div> | |
| 2963c343 RK |
3953 | </section> |
| 3954 | </div> | |
| 3955 | <div class="doc-examples"> | |
| 3956 | <h5>Response Content-Types: | |
| 3957 | <span>application/json</span> | |
| 3958 | </h5> | |
| 3959 | <section> | |
| 3960 | <h5>Response Example | |
| 3961 | <span>(200 OK)</span> | |
| 3962 | </h5> | |
| 3963 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 3964 | <span class="hljs-attr">"comment"</span>: { | |
| 3965 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 3966 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 3967 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 3968 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 3969 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 3970 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 3971 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3972 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3973 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 3974 | <span class="hljs-attr">"account"</span>: { | |
| 3975 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 3976 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 3977 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 3978 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 3979 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 3980 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 3981 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 3982 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 3983 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3984 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3985 | <span class="hljs-attr">"avatar"</span>: { | |
| 3986 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 3987 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 3988 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 3989 | } | |
| 3990 | } | |
| 3991 | }, | |
| 3992 | <span class="hljs-attr">"children"</span>: [ | |
| 3993 | { | |
| 3994 | <span class="hljs-attr">"comment"</span>: { | |
| 3995 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 3996 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 3997 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 3998 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 3999 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 4000 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 4001 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4002 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4003 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 4004 | <span class="hljs-attr">"account"</span>: { | |
| 4005 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 4006 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 4007 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 4008 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 4009 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 4010 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 4011 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 4012 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 4013 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4014 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4015 | <span class="hljs-attr">"avatar"</span>: { | |
| 4016 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 4017 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4018 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 4019 | } | |
| 4020 | } | |
| 4021 | }, | |
| 4022 | <span class="hljs-attr">"children"</span>: [ | |
| 4023 | { | |
| 4024 | <span class="hljs-attr">"comment"</span>: { | |
| 4025 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 4026 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 4027 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 4028 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 4029 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 4030 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 4031 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4032 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4033 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 4034 | <span class="hljs-attr">"account"</span>: { | |
| 4035 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 4036 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 4037 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 4038 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 4039 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 4040 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 4041 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 4042 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4043 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4044 | <span class="hljs-attr">"avatar"</span>: { | |
| 4045 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 4046 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4047 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 4048 | } | |
| 4049 | } | |
| 4050 | } | |
| 4051 | } | |
| 4052 | ] | |
| 4053 | } | |
| 4054 | ] | |
| 4055 | } | |
| 4056 | </code></pre> | |
| 4057 | <!-- </div> --> | |
| 4058 | </section> | |
| 4059 | </div> | |
| 4060 | </div> | |
| 4061 | </div> | |
| 4062 | <div id="operation--videos--id--comments--commentId--post" class="operation panel" data-traverse-target="operation--videos--id--comments--commentId--post"> | |
| 4063 | <!-- <section class="operation-tags row"> --> | |
| 4064 | <!-- <div class="doc-copy"> --> | |
| 4065 | <div class="operation-tags"> | |
| 4066 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
| 4067 | <!----> | |
| 4068 | </div> | |
| 4069 | <!-- </div> --> | |
| 4070 | <!-- </section> --> | |
| 4071 | <h2 class="operation-title"> | |
| 4072 | <span class="operation-summary">Creates a comment in a comment thread by its id, of a video by its id</span> | |
| 4073 | </h2> | |
| 4074 | <div class="doc-row"> | |
| 4075 | <div class="doc-copy"> | |
| 4076 | <section class="swagger-operation-path"> | |
| 4077 | <span class="operation-method">POST</span> | |
| 4078 | <span class="operation-path">/videos/{id}/comments/{commentId}</span> | |
| 4079 | </section> | |
| 4080 | </div> | |
| 4081 | </div> | |
| 4082 | <div class="doc-row"> | |
| 4083 | <div class="doc-copy"> | |
| 4084 | <section class="swagger-request-params"> | |
| 61b66b36 C |
4085 | <div class="prop-row prop-group"> |
| 4086 | <div class="prop-name"> | |
| 2963c343 | 4087 | <div class="prop-title">id: |
| 330eaf12 C |
4088 | <span class="prop-type"> |
| 4089 | <span class="json-property-type">string</span> | |
| 4090 | <span class="json-property-range" title="Value limits"></span> | |
| 4091 | </span> | |
| 228e84aa | 4092 | </div> |
| 2963c343 RK |
4093 | <span class="json-property-required"></span> |
| 4094 | <div class="prop-subtitle"> in path </div> | |
| 61b66b36 C |
4095 | </div> |
| 4096 | <div class="prop-value"> | |
| 2963c343 | 4097 | <p>The video id or uuid</p> |
| 61b66b36 C |
4098 | </div> |
| 4099 | </div> | |
| 61b66b36 C |
4100 | <div class="prop-row prop-group"> |
| 4101 | <div class="prop-name"> | |
| 2963c343 | 4102 | <div class="prop-title">threadId: |
| 330eaf12 | 4103 | <span class="prop-type"> |
| 2963c343 | 4104 | <span class="json-property-type">number</span> |
| 330eaf12 C |
4105 | <span class="json-property-range" title="Value limits"></span> |
| 4106 | </span> | |
| 228e84aa | 4107 | </div> |
| 2963c343 RK |
4108 | <span class="json-property-required"></span> |
| 4109 | <div class="prop-subtitle"> in path </div> | |
| 61b66b36 C |
4110 | </div> |
| 4111 | <div class="prop-value"> | |
| 2963c343 | 4112 | <p>The comment id</p> |
| 61b66b36 C |
4113 | </div> |
| 4114 | </div> | |
| 2963c343 RK |
4115 | </section> |
| 4116 | </div> | |
| 4117 | <div class="doc-examples"></div> | |
| 4118 | </div> | |
| 4119 | <div class="doc-row"> | |
| 4120 | <div class="doc-copy"> | |
| 4121 | <section class="swagger-responses"> | |
| 61b66b36 C |
4122 | <div class="prop-row prop-group"> |
| 4123 | <div class="prop-name"> | |
| 2963c343 RK |
4124 | <div class="prop-title">200 OK</div> |
| 4125 | <div class="prop-ref"> | |
| 4126 | <span class=""> | |
| 4127 | <a class="json-schema-ref" href="#/definitions/CommentThreadPostResponse">CommentThreadPostResponse</a> | |
| 330eaf12 | 4128 | </span> |
| 228e84aa | 4129 | </div> |
| 2963c343 | 4130 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> |
| 61b66b36 C |
4131 | </div> |
| 4132 | <div class="prop-value"> | |
| 2963c343 | 4133 | <p>successful operation</p> |
| 61b66b36 C |
4134 | </div> |
| 4135 | </div> | |
| 2963c343 RK |
4136 | </section> |
| 4137 | </div> | |
| 4138 | <div class="doc-examples"> | |
| 4139 | <h5>Response Content-Types: | |
| 4140 | <span>application/json</span> | |
| 4141 | </h5> | |
| 4142 | <section> | |
| 4143 | <h5>Response Example | |
| 4144 | <span>(200 OK)</span> | |
| 4145 | </h5> | |
| 4146 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 4147 | <span class="hljs-attr">"comment"</span>: { | |
| 4148 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 4149 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 4150 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 4151 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 4152 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 4153 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 4154 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4155 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4156 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 4157 | <span class="hljs-attr">"account"</span>: { | |
| 4158 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 4159 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 4160 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 4161 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 4162 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 4163 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 4164 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 4165 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 4166 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4167 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4168 | <span class="hljs-attr">"avatar"</span>: { | |
| 4169 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 4170 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4171 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 4172 | } | |
| 4173 | } | |
| 4174 | } | |
| 4175 | } | |
| 4176 | </code></pre> | |
| 4177 | <!-- </div> --> | |
| 4178 | </section> | |
| 4179 | </div> | |
| 4180 | </div> | |
| 4181 | <div class="doc-row"> | |
| 4182 | <div class="doc-copy"> | |
| 4183 | <section class="swagger-request-security"> | |
| 4184 | <table class="table"> | |
| 4185 | <thead> | |
| 4186 | <tr> | |
| 4187 | <th class="swagger-request-security-schema"></th> | |
| 4188 | <th class="swagger-request-security-scopes"></th> | |
| 4189 | </tr> | |
| 4190 | </thead> | |
| 4191 | <tbody> | |
| 4192 | <tr> | |
| 4193 | <td> | |
| 4194 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 4195 | </td> | |
| 4196 | <td> </td> | |
| 4197 | </tr> | |
| 4198 | </tbody> | |
| 4199 | </table> | |
| 4200 | </section> | |
| 4201 | </div> | |
| 4202 | </div> | |
| 4203 | </div> | |
| 4204 | <div id="operation--videos--id--comments--commentId--delete" class="operation panel" data-traverse-target="operation--videos--id--comments--commentId--delete"> | |
| 4205 | <!-- <section class="operation-tags row"> --> | |
| 4206 | <!-- <div class="doc-copy"> --> | |
| 4207 | <div class="operation-tags"> | |
| 4208 | <a class="label" href="#tag-VideoComment">VideoComment</a> | |
| 4209 | <!----> | |
| 4210 | </div> | |
| 4211 | <!-- </div> --> | |
| 4212 | <!-- </section> --> | |
| 4213 | <h2 class="operation-title"> | |
| 4214 | <span class="operation-summary">Delete a comment in a comment therad by its id, of a video by its id</span> | |
| 4215 | </h2> | |
| 4216 | <div class="doc-row"> | |
| 4217 | <div class="doc-copy"> | |
| 4218 | <section class="swagger-operation-path"> | |
| 4219 | <span class="operation-method">DELETE</span> | |
| 4220 | <span class="operation-path">/videos/{id}/comments/{commentId}</span> | |
| 4221 | </section> | |
| 4222 | </div> | |
| 4223 | </div> | |
| 4224 | <div class="doc-row"> | |
| 4225 | <div class="doc-copy"> | |
| 4226 | <section class="swagger-request-params"> | |
| 61b66b36 C |
4227 | <div class="prop-row prop-group"> |
| 4228 | <div class="prop-name"> | |
| 2963c343 | 4229 | <div class="prop-title">id: |
| 330eaf12 C |
4230 | <span class="prop-type"> |
| 4231 | <span class="json-property-type">string</span> | |
| 4232 | <span class="json-property-range" title="Value limits"></span> | |
| 4233 | </span> | |
| 228e84aa | 4234 | </div> |
| 2963c343 RK |
4235 | <span class="json-property-required"></span> |
| 4236 | <div class="prop-subtitle"> in path </div> | |
| 5e1c08eb C |
4237 | </div> |
| 4238 | <div class="prop-value"> | |
| 2963c343 | 4239 | <p>The video id or uuid</p> |
| 5e1c08eb C |
4240 | </div> |
| 4241 | </div> | |
| 5e1c08eb C |
4242 | <div class="prop-row prop-group"> |
| 4243 | <div class="prop-name"> | |
| 2963c343 | 4244 | <div class="prop-title">threadId: |
| 330eaf12 | 4245 | <span class="prop-type"> |
| 2963c343 | 4246 | <span class="json-property-type">number</span> |
| 330eaf12 C |
4247 | <span class="json-property-range" title="Value limits"></span> |
| 4248 | </span> | |
| 228e84aa | 4249 | </div> |
| 2963c343 RK |
4250 | <span class="json-property-required"></span> |
| 4251 | <div class="prop-subtitle"> in path </div> | |
| 5e1c08eb C |
4252 | </div> |
| 4253 | <div class="prop-value"> | |
| 2963c343 | 4254 | <p>The comment id</p> |
| 5e1c08eb C |
4255 | </div> |
| 4256 | </div> | |
| 2963c343 RK |
4257 | </section> |
| 4258 | </div> | |
| 4259 | <div class="doc-examples"></div> | |
| 4260 | </div> | |
| 4261 | <div class="doc-row"> | |
| 4262 | <div class="doc-copy"> | |
| 4263 | <section class="swagger-responses"> | |
| 5e1c08eb C |
4264 | <div class="prop-row prop-group"> |
| 4265 | <div class="prop-name"> | |
| 2963c343 | 4266 | <div class="prop-title">204 No Content</div> |
| 5e1c08eb C |
4267 | </div> |
| 4268 | <div class="prop-value"> | |
| 2963c343 | 4269 | <p>Successful operation</p> |
| 5e1c08eb C |
4270 | </div> |
| 4271 | </div> | |
| 2963c343 RK |
4272 | </section> |
| 4273 | </div> | |
| 4274 | <div class="doc-examples"> | |
| 4275 | <h5>Response Content-Types: | |
| 4276 | <span>application/json</span> | |
| 4277 | </h5> | |
| 4278 | </div> | |
| 4279 | </div> | |
| 4280 | <div class="doc-row"> | |
| 4281 | <div class="doc-copy"> | |
| 4282 | <section class="swagger-request-security"> | |
| 4283 | <table class="table"> | |
| 4284 | <thead> | |
| 4285 | <tr> | |
| 4286 | <th class="swagger-request-security-schema"></th> | |
| 4287 | <th class="swagger-request-security-scopes"></th> | |
| 4288 | </tr> | |
| 4289 | </thead> | |
| 4290 | <tbody> | |
| 4291 | <tr> | |
| 4292 | <td> | |
| 4293 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 4294 | </td> | |
| 4295 | <td> </td> | |
| 4296 | </tr> | |
| 4297 | </tbody> | |
| 4298 | </table> | |
| 4299 | </section> | |
| 4300 | </div> | |
| 4301 | </div> | |
| 4302 | </div> | |
| 4303 | <h1 id="tag-VideoChannel" class="swagger-summary-tag" data-traverse-target="tag-VideoChannel">VideoChannel</h1> | |
| 4304 | <div class="tag-description doc-row"> | |
| 4305 | <div class="doc-copy"> | |
| 4306 | <p>Operations dealing with creation, modification and video listing of a user's channels.</p> | |
| 4307 | </div> | |
| 4308 | </div> | |
| 4309 | <div id="operation--video-channels-get" class="operation panel" data-traverse-target="operation--video-channels-get"> | |
| 4310 | <!-- <section class="operation-tags row"> --> | |
| 4311 | <!-- <div class="doc-copy"> --> | |
| 4312 | <div class="operation-tags"> | |
| 4313 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
| 4314 | <!----> | |
| 4315 | </div> | |
| 4316 | <!-- </div> --> | |
| 4317 | <!-- </section> --> | |
| 4318 | <h2 class="operation-title"> | |
| 4319 | <span class="operation-summary">Get list of video channels</span> | |
| 4320 | </h2> | |
| 4321 | <div class="doc-row"> | |
| 4322 | <div class="doc-copy"> | |
| 4323 | <section class="swagger-operation-path"> | |
| 4324 | <span class="operation-method">GET</span> | |
| 4325 | <span class="operation-path">/video-channels</span> | |
| 4326 | </section> | |
| 4327 | </div> | |
| 4328 | </div> | |
| 4329 | <div class="doc-row"> | |
| 4330 | <div class="doc-copy"> | |
| 4331 | <section class="swagger-request-params"> | |
| 5e1c08eb C |
4332 | <div class="prop-row prop-group"> |
| 4333 | <div class="prop-name"> | |
| 2963c343 | 4334 | <div class="prop-title">start: |
| 330eaf12 | 4335 | <span class="prop-type"> |
| 2963c343 | 4336 | <span class="json-property-type">number</span> |
| 330eaf12 C |
4337 | <span class="json-property-range" title="Value limits"></span> |
| 4338 | </span> | |
| 228e84aa | 4339 | </div> |
| 2963c343 | 4340 | <div class="prop-subtitle"> in query </div> |
| 5e1c08eb C |
4341 | </div> |
| 4342 | <div class="prop-value"> | |
| 2963c343 | 4343 | <p>Offset</p> |
| 5e1c08eb C |
4344 | </div> |
| 4345 | </div> | |
| 5e1c08eb C |
4346 | <div class="prop-row prop-group"> |
| 4347 | <div class="prop-name"> | |
| 2963c343 | 4348 | <div class="prop-title">count: |
| 330eaf12 | 4349 | <span class="prop-type"> |
| 2963c343 | 4350 | <span class="json-property-type">number</span> |
| 330eaf12 C |
4351 | <span class="json-property-range" title="Value limits"></span> |
| 4352 | </span> | |
| 228e84aa | 4353 | </div> |
| 2963c343 | 4354 | <div class="prop-subtitle"> in query </div> |
| 5e1c08eb C |
4355 | </div> |
| 4356 | <div class="prop-value"> | |
| 2963c343 | 4357 | <p>Number of items</p> |
| 5e1c08eb C |
4358 | </div> |
| 4359 | </div> | |
| 61b66b36 C |
4360 | <div class="prop-row prop-group"> |
| 4361 | <div class="prop-name"> | |
| 2963c343 | 4362 | <div class="prop-title">sort: |
| 330eaf12 C |
4363 | <span class="prop-type"> |
| 4364 | <span class="json-property-type">string</span> | |
| 330eaf12 C |
4365 | <span class="json-property-range" title="Value limits"></span> |
| 4366 | </span> | |
| 228e84aa | 4367 | </div> |
| 2963c343 | 4368 | <div class="prop-subtitle"> in query </div> |
| bbe0f064 C |
4369 | </div> |
| 4370 | <div class="prop-value"> | |
| 2963c343 | 4371 | <p>Sort column (-createdAt for example)</p> |
| bbe0f064 C |
4372 | </div> |
| 4373 | </div> | |
| 5e1c08eb C |
4374 | </section> |
| 4375 | </div> | |
| 4376 | <div class="doc-examples"></div> | |
| 4377 | </div> | |
| 4378 | <div class="doc-row"> | |
| 4379 | <div class="doc-copy"> | |
| 4380 | <section class="swagger-responses"> | |
| 4381 | <div class="prop-row prop-group"> | |
| 4382 | <div class="prop-name"> | |
| 4383 | <div class="prop-title">200 OK</div> | |
| 4384 | <div class="prop-ref"> | |
| 2963c343 RK |
4385 | <span class="json-schema-ref-array"> |
| 4386 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
| 5e1c08eb C |
4387 | </span> |
| 4388 | </div> | |
| 4389 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 4390 | </div> | |
| 4391 | <div class="prop-value"> | |
| 4392 | <p>successful operation</p> | |
| 4393 | </div> | |
| 4394 | </div> | |
| 2963c343 RK |
4395 | <div class="prop-row prop-inner"> |
| 4396 | <div class="prop-name">type</div> | |
| 4397 | <div class="prop-value"> | |
| 4398 | <span class="json-property-type"> | |
| 4399 | <span class="json-schema-ref-array"> | |
| 4400 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
| 4401 | </span> | |
| 4402 | </span> | |
| 4403 | <span class="json-property-range" title="Value limits"></span> | |
| 4404 | </div> | |
| 4405 | </div> | |
| 5e1c08eb C |
4406 | </section> |
| 4407 | </div> | |
| 4408 | <div class="doc-examples"> | |
| 4409 | <h5>Response Content-Types: | |
| 4410 | <span>application/json</span> | |
| 4411 | </h5> | |
| 4412 | <section> | |
| 4413 | <h5>Response Example | |
| 4414 | <span>(200 OK)</span> | |
| 4415 | </h5> | |
| 2963c343 RK |
4416 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ |
| 4417 | { | |
| 4418 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 4419 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 4420 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 4421 | <span class="hljs-attr">"ownerAccount"</span>: { | |
| 4422 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 4423 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
| 4424 | } | |
| 61b66b36 | 4425 | } |
| 2963c343 RK |
4426 | ] |
| 4427 | </code></pre> | |
| 4428 | <!-- </div> --> | |
| 4429 | </section> | |
| 4430 | </div> | |
| 4431 | </div> | |
| 4432 | </div> | |
| 4433 | <div id="operation--video-channels-post" class="operation panel" data-traverse-target="operation--video-channels-post"> | |
| 4434 | <!-- <section class="operation-tags row"> --> | |
| 4435 | <!-- <div class="doc-copy"> --> | |
| 4436 | <div class="operation-tags"> | |
| 4437 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
| 4438 | <!----> | |
| 4439 | </div> | |
| 4440 | <!-- </div> --> | |
| 4441 | <!-- </section> --> | |
| 4442 | <h2 class="operation-title"> | |
| 4443 | <span class="operation-summary">Creates a video channel for the current user</span> | |
| 4444 | </h2> | |
| 4445 | <div class="doc-row"> | |
| 4446 | <div class="doc-copy"> | |
| 4447 | <section class="swagger-operation-path"> | |
| 4448 | <span class="operation-method">POST</span> | |
| 4449 | <span class="operation-path">/video-channels</span> | |
| 4450 | </section> | |
| 4451 | </div> | |
| 4452 | </div> | |
| 4453 | <div class="doc-row"> | |
| 4454 | <div class="doc-copy"> | |
| 4455 | <section class="swagger-request-body"> | |
| 4456 | <div class="prop-row"> | |
| 4457 | <div class="prop-name"> | |
| 4458 | <div class="swagger-request-model"> | |
| 4459 | <span class=""> | |
| 4460 | <a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a> | |
| 4461 | </span> | |
| 4462 | </div> | |
| 4463 | </div> | |
| 4464 | <div class="prop-value columns small-6"> | |
| 4465 | <!-- <div class="swagger-request-description"> --> | |
| 4466 | <p>undefined</p> | |
| 4467 | <!-- </div> --> | |
| 4468 | </div> | |
| 4469 | </div> | |
| 4470 | </section> | |
| 4471 | </div> | |
| 4472 | <div class="doc-examples"> | |
| 4473 | <section> | |
| 4474 | <h5>Request Content-Types: | |
| 4475 | <span>application/json</span> | |
| 4476 | </h5> | |
| 4477 | <h5>Request Example</h5> | |
| 4478 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 4479 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 4480 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span> | |
| 5e1c08eb C |
4481 | } |
| 4482 | </code></pre> | |
| 4483 | <!-- </div> --> | |
| 4484 | </section> | |
| 4485 | </div> | |
| 4486 | </div> | |
| 2963c343 RK |
4487 | <div class="doc-row"> |
| 4488 | <div class="doc-copy"> | |
| 4489 | <section class="swagger-responses"> | |
| 4490 | <div class="prop-row prop-group"> | |
| 4491 | <div class="prop-name"> | |
| 4492 | <div class="prop-title">204 No Content</div> | |
| 4493 | </div> | |
| 4494 | <div class="prop-value"> | |
| 4495 | <p>Successful operation</p> | |
| 4496 | </div> | |
| 4497 | </div> | |
| 4498 | </section> | |
| 4499 | </div> | |
| 4500 | <div class="doc-examples"> | |
| 4501 | <h5>Response Content-Types: | |
| 4502 | <span>application/json</span> | |
| 4503 | </h5> | |
| 4504 | </div> | |
| 4505 | </div> | |
| 94ff4c23 C |
4506 | <div class="doc-row"> |
| 4507 | <div class="doc-copy"> | |
| 4508 | <section class="swagger-request-security"> | |
| 4509 | <table class="table"> | |
| 4510 | <thead> | |
| 4511 | <tr> | |
| 4512 | <th class="swagger-request-security-schema"></th> | |
| 4513 | <th class="swagger-request-security-scopes"></th> | |
| 4514 | </tr> | |
| 4515 | </thead> | |
| 4516 | <tbody> | |
| 4517 | <tr> | |
| 4518 | <td> | |
| 4519 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 4520 | </td> | |
| 4521 | <td> </td> | |
| 4522 | </tr> | |
| 4523 | </tbody> | |
| 4524 | </table> | |
| 4525 | </section> | |
| 4526 | </div> | |
| 4527 | </div> | |
| 5e1c08eb | 4528 | </div> |
| 2963c343 | 4529 | <div id="operation--video-channels--id--get" class="operation panel" data-traverse-target="operation--video-channels--id--get"> |
| 5e1c08eb C |
4530 | <!-- <section class="operation-tags row"> --> |
| 4531 | <!-- <div class="doc-copy"> --> | |
| 4532 | <div class="operation-tags"> | |
| 2963c343 | 4533 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> |
| 5e1c08eb C |
4534 | <!----> |
| 4535 | </div> | |
| 4536 | <!-- </div> --> | |
| 4537 | <!-- </section> --> | |
| 4538 | <h2 class="operation-title"> | |
| 2963c343 | 4539 | <span class="operation-summary">Get a video channel by its id</span> |
| 5e1c08eb | 4540 | </h2> |
| 2963c343 RK |
4541 | <div class="doc-row"> |
| 4542 | <div class="doc-copy"> | |
| 4543 | <section class="swagger-operation-path"> | |
| 4544 | <span class="operation-method">GET</span> | |
| 4545 | <span class="operation-path">/video-channels/{id}</span> | |
| 4546 | </section> | |
| 4547 | </div> | |
| 4548 | </div> | |
| 5e1c08eb | 4549 | <div class="doc-row"> |
| ab0ee6a1 C |
4550 | <div class="doc-copy"> |
| 4551 | <section class="swagger-request-params"> | |
| 4552 | <div class="prop-row prop-group"> | |
| 4553 | <div class="prop-name"> | |
| 2963c343 | 4554 | <div class="prop-title">id: |
| 330eaf12 C |
4555 | <span class="prop-type"> |
| 4556 | <span class="json-property-type">string</span> | |
| 4557 | <span class="json-property-range" title="Value limits"></span> | |
| 4558 | </span> | |
| 228e84aa | 4559 | </div> |
| 2963c343 RK |
4560 | <span class="json-property-required"></span> |
| 4561 | <div class="prop-subtitle"> in path </div> | |
| ab0ee6a1 C |
4562 | </div> |
| 4563 | <div class="prop-value"> | |
| 2963c343 | 4564 | <p>The video channel id or uuid</p> |
| ab0ee6a1 C |
4565 | </div> |
| 4566 | </div> | |
| ab0ee6a1 C |
4567 | </section> |
| 4568 | </div> | |
| 5e1c08eb C |
4569 | <div class="doc-examples"></div> |
| 4570 | </div> | |
| 4571 | <div class="doc-row"> | |
| 4572 | <div class="doc-copy"> | |
| 4573 | <section class="swagger-responses"> | |
| 4574 | <div class="prop-row prop-group"> | |
| 4575 | <div class="prop-name"> | |
| 4576 | <div class="prop-title">200 OK</div> | |
| 4577 | <div class="prop-ref"> | |
| 2963c343 RK |
4578 | <span class=""> |
| 4579 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
| 5e1c08eb C |
4580 | </span> |
| 4581 | </div> | |
| 4582 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 4583 | </div> | |
| 4584 | <div class="prop-value"> | |
| 4585 | <p>successful operation</p> | |
| 4586 | </div> | |
| 4587 | </div> | |
| 4588 | </section> | |
| 4589 | </div> | |
| 4590 | <div class="doc-examples"> | |
| 4591 | <h5>Response Content-Types: | |
| 4592 | <span>application/json</span> | |
| 4593 | </h5> | |
| 4594 | <section> | |
| 4595 | <h5>Response Example | |
| 4596 | <span>(200 OK)</span> | |
| 4597 | </h5> | |
| 2963c343 RK |
4598 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ |
| 4599 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 4600 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 4601 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 4602 | <span class="hljs-attr">"ownerAccount"</span>: { | |
| 5e1c08eb | 4603 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, |
| 2963c343 | 4604 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> |
| 5e1c08eb | 4605 | } |
| 2963c343 RK |
4606 | } |
| 4607 | </code></pre> | |
| 4608 | <!-- </div> --> | |
| 4609 | </section> | |
| 4610 | </div> | |
| 4611 | </div> | |
| 4612 | </div> | |
| 4613 | <div id="operation--video-channels--id--put" class="operation panel" data-traverse-target="operation--video-channels--id--put"> | |
| 4614 | <!-- <section class="operation-tags row"> --> | |
| 4615 | <!-- <div class="doc-copy"> --> | |
| 4616 | <div class="operation-tags"> | |
| 4617 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> | |
| 4618 | <!----> | |
| 4619 | </div> | |
| 4620 | <!-- </div> --> | |
| 4621 | <!-- </section> --> | |
| 4622 | <h2 class="operation-title"> | |
| 4623 | <span class="operation-summary">Update a video channel by its id</span> | |
| 4624 | </h2> | |
| 4625 | <div class="doc-row"> | |
| 4626 | <div class="doc-copy"> | |
| 4627 | <section class="swagger-operation-path"> | |
| 4628 | <span class="operation-method">PUT</span> | |
| 4629 | <span class="operation-path">/video-channels/{id}</span> | |
| 4630 | </section> | |
| 4631 | </div> | |
| 4632 | </div> | |
| 4633 | <div class="doc-row"> | |
| 4634 | <div class="doc-copy"> | |
| 4635 | <section class="swagger-request-body"> | |
| 4636 | <div class="prop-row"> | |
| 4637 | <div class="prop-name"> | |
| 4638 | <div class="swagger-request-model"> | |
| 4639 | <span class=""> | |
| 4640 | <a class="json-schema-ref" href="#/definitions/VideoChannelInput">VideoChannelInput</a> | |
| 4641 | </span> | |
| 4642 | </div> | |
| 4643 | </div> | |
| 4644 | <div class="prop-value columns small-6"> | |
| 4645 | <!-- <div class="swagger-request-description"> --> | |
| 4646 | <p>undefined</p> | |
| 4647 | <!-- </div> --> | |
| 4648 | </div> | |
| 4649 | </div> | |
| 4650 | </section> | |
| 4651 | <section class="swagger-request-params"> | |
| 4652 | <div class="prop-row prop-group"> | |
| 4653 | <div class="prop-name"> | |
| 4654 | <div class="prop-title">id: | |
| 4655 | <span class="prop-type"> | |
| 4656 | <span class="json-property-type">string</span> | |
| 4657 | <span class="json-property-range" title="Value limits"></span> | |
| 4658 | </span> | |
| 4659 | </div> | |
| 4660 | <span class="json-property-required"></span> | |
| 4661 | <div class="prop-subtitle"> in path </div> | |
| 4662 | </div> | |
| 4663 | <div class="prop-value"> | |
| 4664 | <p>The video channel id or uuid</p> | |
| 4665 | </div> | |
| 4666 | </div> | |
| 4667 | </section> | |
| 4668 | </div> | |
| 4669 | <div class="doc-examples"> | |
| 4670 | <section> | |
| 4671 | <h5>Request Content-Types: | |
| 4672 | <span>application/json</span> | |
| 4673 | </h5> | |
| 4674 | <h5>Request Example</h5> | |
| 4675 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 4676 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 4677 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span> | |
| 4678 | } | |
| 5e1c08eb C |
4679 | </code></pre> |
| 4680 | <!-- </div> --> | |
| 4681 | </section> | |
| 4682 | </div> | |
| 4683 | </div> | |
| 2963c343 RK |
4684 | <div class="doc-row"> |
| 4685 | <div class="doc-copy"> | |
| 4686 | <section class="swagger-responses"> | |
| 4687 | <div class="prop-row prop-group"> | |
| 4688 | <div class="prop-name"> | |
| 4689 | <div class="prop-title">204 No Content</div> | |
| 4690 | </div> | |
| 4691 | <div class="prop-value"> | |
| 4692 | <p>Successful operation</p> | |
| 4693 | </div> | |
| 4694 | </div> | |
| 4695 | </section> | |
| 4696 | </div> | |
| 4697 | <div class="doc-examples"> | |
| 4698 | <h5>Response Content-Types: | |
| 4699 | <span>application/json</span> | |
| 4700 | </h5> | |
| 4701 | </div> | |
| 4702 | </div> | |
| 94ff4c23 C |
4703 | <div class="doc-row"> |
| 4704 | <div class="doc-copy"> | |
| 4705 | <section class="swagger-request-security"> | |
| 4706 | <table class="table"> | |
| 4707 | <thead> | |
| 4708 | <tr> | |
| 4709 | <th class="swagger-request-security-schema"></th> | |
| 4710 | <th class="swagger-request-security-scopes"></th> | |
| 4711 | </tr> | |
| 4712 | </thead> | |
| 4713 | <tbody> | |
| 4714 | <tr> | |
| 4715 | <td> | |
| 4716 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 4717 | </td> | |
| 4718 | <td> </td> | |
| 4719 | </tr> | |
| 4720 | </tbody> | |
| 4721 | </table> | |
| 4722 | </section> | |
| 4723 | </div> | |
| 4724 | </div> | |
| 5e1c08eb | 4725 | </div> |
| 2963c343 | 4726 | <div id="operation--video-channels--id--delete" class="operation panel" data-traverse-target="operation--video-channels--id--delete"> |
| 5e1c08eb C |
4727 | <!-- <section class="operation-tags row"> --> |
| 4728 | <!-- <div class="doc-copy"> --> | |
| 4729 | <div class="operation-tags"> | |
| 2963c343 | 4730 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> |
| 5e1c08eb C |
4731 | <!----> |
| 4732 | </div> | |
| 4733 | <!-- </div> --> | |
| 4734 | <!-- </section> --> | |
| 4735 | <h2 class="operation-title"> | |
| 2963c343 | 4736 | <span class="operation-summary">Delete a video channel by its id</span> |
| 5e1c08eb | 4737 | </h2> |
| 2963c343 RK |
4738 | <div class="doc-row"> |
| 4739 | <div class="doc-copy"> | |
| 4740 | <section class="swagger-operation-path"> | |
| 4741 | <span class="operation-method">DELETE</span> | |
| 4742 | <span class="operation-path">/video-channels/{id}</span> | |
| 4743 | </section> | |
| 4744 | </div> | |
| 4745 | </div> | |
| 5e1c08eb C |
4746 | <div class="doc-row"> |
| 4747 | <div class="doc-copy"> | |
| 4748 | <section class="swagger-request-params"> | |
| 4749 | <div class="prop-row prop-group"> | |
| 4750 | <div class="prop-name"> | |
| 330eaf12 C |
4751 | <div class="prop-title">id: |
| 4752 | <span class="prop-type"> | |
| 4753 | <span class="json-property-type">string</span> | |
| 4754 | <span class="json-property-range" title="Value limits"></span> | |
| 4755 | </span> | |
| 4756 | </div> | |
| 5e1c08eb | 4757 | <span class="json-property-required"></span> |
| 228e84aa | 4758 | <div class="prop-subtitle"> in path </div> |
| 5e1c08eb C |
4759 | </div> |
| 4760 | <div class="prop-value"> | |
| 2963c343 | 4761 | <p>The video channel id or uuid</p> |
| 5e1c08eb C |
4762 | </div> |
| 4763 | </div> | |
| 5e1c08eb C |
4764 | </section> |
| 4765 | </div> | |
| 4766 | <div class="doc-examples"></div> | |
| 4767 | </div> | |
| 4768 | <div class="doc-row"> | |
| 4769 | <div class="doc-copy"> | |
| 4770 | <section class="swagger-responses"> | |
| 4771 | <div class="prop-row prop-group"> | |
| 4772 | <div class="prop-name"> | |
| 4773 | <div class="prop-title">204 No Content</div> | |
| 4774 | </div> | |
| 4775 | <div class="prop-value"> | |
| 330eaf12 | 4776 | <p>Successful operation</p> |
| 5e1c08eb C |
4777 | </div> |
| 4778 | </div> | |
| 4779 | </section> | |
| 4780 | </div> | |
| 4781 | <div class="doc-examples"> | |
| 4782 | <h5>Response Content-Types: | |
| 4783 | <span>application/json</span> | |
| 4784 | </h5> | |
| 4785 | </div> | |
| 4786 | </div> | |
| 94ff4c23 C |
4787 | <div class="doc-row"> |
| 4788 | <div class="doc-copy"> | |
| 4789 | <section class="swagger-request-security"> | |
| 4790 | <table class="table"> | |
| 4791 | <thead> | |
| 4792 | <tr> | |
| 4793 | <th class="swagger-request-security-schema"></th> | |
| 4794 | <th class="swagger-request-security-scopes"></th> | |
| 4795 | </tr> | |
| 4796 | </thead> | |
| 4797 | <tbody> | |
| 4798 | <tr> | |
| 4799 | <td> | |
| 4800 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 4801 | </td> | |
| 4802 | <td> </td> | |
| 4803 | </tr> | |
| 4804 | </tbody> | |
| 4805 | </table> | |
| 4806 | </section> | |
| 4807 | </div> | |
| 4808 | </div> | |
| 5e1c08eb | 4809 | </div> |
| 2963c343 | 4810 | <div id="operation--video-channels--id--videos-get" class="operation panel" data-traverse-target="operation--video-channels--id--videos-get"> |
| 5e1c08eb C |
4811 | <!-- <section class="operation-tags row"> --> |
| 4812 | <!-- <div class="doc-copy"> --> | |
| 4813 | <div class="operation-tags"> | |
| 2963c343 | 4814 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> |
| 5e1c08eb C |
4815 | <!----> |
| 4816 | </div> | |
| 4817 | <!-- </div> --> | |
| 4818 | <!-- </section> --> | |
| 4819 | <h2 class="operation-title"> | |
| 2963c343 | 4820 | <span class="operation-summary">Get videos of a video channel by its id</span> |
| 5e1c08eb | 4821 | </h2> |
| 2963c343 RK |
4822 | <div class="doc-row"> |
| 4823 | <div class="doc-copy"> | |
| 4824 | <section class="swagger-operation-path"> | |
| 4825 | <span class="operation-method">GET</span> | |
| 4826 | <span class="operation-path">/video-channels/{id}/videos</span> | |
| 4827 | </section> | |
| 4828 | </div> | |
| 4829 | </div> | |
| 5e1c08eb C |
4830 | <div class="doc-row"> |
| 4831 | <div class="doc-copy"> | |
| 4832 | <section class="swagger-request-params"> | |
| 4833 | <div class="prop-row prop-group"> | |
| 4834 | <div class="prop-name"> | |
| 330eaf12 C |
4835 | <div class="prop-title">id: |
| 4836 | <span class="prop-type"> | |
| 4837 | <span class="json-property-type">string</span> | |
| 4838 | <span class="json-property-range" title="Value limits"></span> | |
| 4839 | </span> | |
| 4840 | </div> | |
| 5e1c08eb | 4841 | <span class="json-property-required"></span> |
| 228e84aa | 4842 | <div class="prop-subtitle"> in path </div> |
| 5e1c08eb C |
4843 | </div> |
| 4844 | <div class="prop-value"> | |
| 2963c343 | 4845 | <p>The video channel id or uuid</p> |
| 5e1c08eb C |
4846 | </div> |
| 4847 | </div> | |
| 5e1c08eb C |
4848 | </section> |
| 4849 | </div> | |
| 4850 | <div class="doc-examples"></div> | |
| 4851 | </div> | |
| 4852 | <div class="doc-row"> | |
| 4853 | <div class="doc-copy"> | |
| 4854 | <section class="swagger-responses"> | |
| 4855 | <div class="prop-row prop-group"> | |
| 4856 | <div class="prop-name"> | |
| 2963c343 RK |
4857 | <div class="prop-title">200 OK</div> |
| 4858 | <div class="prop-ref"> | |
| 4859 | <span class=""> | |
| 4860 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
| 4861 | </span> | |
| 4862 | </div> | |
| 4863 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 5e1c08eb C |
4864 | </div> |
| 4865 | <div class="prop-value"> | |
| 2963c343 | 4866 | <p>successful operation</p> |
| 5e1c08eb C |
4867 | </div> |
| 4868 | </div> | |
| 4869 | </section> | |
| 4870 | </div> | |
| 4871 | <div class="doc-examples"> | |
| 4872 | <h5>Response Content-Types: | |
| 4873 | <span>application/json</span> | |
| 4874 | </h5> | |
| 2963c343 RK |
4875 | <section> |
| 4876 | <h5>Response Example | |
| 4877 | <span>(200 OK)</span> | |
| 4878 | </h5> | |
| 4879 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 4880 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 4881 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 4882 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4883 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4884 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4885 | <span class="hljs-attr">"category"</span>: { | |
| 4886 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 4887 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 4888 | }, | |
| 4889 | <span class="hljs-attr">"licence"</span>: { | |
| 4890 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 4891 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 4892 | }, | |
| 4893 | <span class="hljs-attr">"language"</span>: { | |
| 4894 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
| 4895 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 4896 | }, | |
| 4897 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | |
| 4898 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 4899 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 4900 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 4901 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 4902 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
| 4903 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
| 4904 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
| 4905 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 4906 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 4907 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 4908 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | |
| 4909 | <span class="hljs-attr">"account"</span>: { | |
| 4910 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 4911 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 4912 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 4913 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 4914 | <span class="hljs-attr">"avatar"</span>: { | |
| 4915 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 4916 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 4917 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 4918 | } | |
| 4919 | } | |
| 4920 | } | |
| 4921 | </code></pre> | |
| 4922 | <!-- </div> --> | |
| 94ff4c23 C |
4923 | </section> |
| 4924 | </div> | |
| 4925 | </div> | |
| 5e1c08eb | 4926 | </div> |
| 2963c343 | 4927 | <div id="operation--accounts--name--video-channels-get" class="operation panel" data-traverse-target="operation--accounts--name--video-channels-get"> |
| 5e1c08eb C |
4928 | <!-- <section class="operation-tags row"> --> |
| 4929 | <!-- <div class="doc-copy"> --> | |
| 4930 | <div class="operation-tags"> | |
| 2963c343 | 4931 | <a class="label" href="#tag-VideoChannel">VideoChannel</a> |
| 5e1c08eb C |
4932 | <!----> |
| 4933 | </div> | |
| 4934 | <!-- </div> --> | |
| 4935 | <!-- </section> --> | |
| 4936 | <h2 class="operation-title"> | |
| 2963c343 | 4937 | <span class="operation-summary">Get video channels of an account by its name</span> |
| 5e1c08eb | 4938 | </h2> |
| 2963c343 RK |
4939 | <div class="doc-row"> |
| 4940 | <div class="doc-copy"> | |
| 4941 | <section class="swagger-operation-path"> | |
| 4942 | <span class="operation-method">GET</span> | |
| 4943 | <span class="operation-path">/accounts/{name}/video-channels</span> | |
| 4944 | </section> | |
| 4945 | </div> | |
| 4946 | </div> | |
| 5e1c08eb C |
4947 | <div class="doc-row"> |
| 4948 | <div class="doc-copy"> | |
| 4949 | <section class="swagger-request-params"> | |
| 4950 | <div class="prop-row prop-group"> | |
| 4951 | <div class="prop-name"> | |
| 2963c343 | 4952 | <div class="prop-title">name: |
| 330eaf12 C |
4953 | <span class="prop-type"> |
| 4954 | <span class="json-property-type">string</span> | |
| 4955 | <span class="json-property-range" title="Value limits"></span> | |
| 4956 | </span> | |
| 4957 | </div> | |
| 5e1c08eb | 4958 | <span class="json-property-required"></span> |
| 228e84aa | 4959 | <div class="prop-subtitle"> in path </div> |
| 5e1c08eb C |
4960 | </div> |
| 4961 | <div class="prop-value"> | |
| 2963c343 RK |
4962 | <p>The name of the account (chocobozzz or |
| 4963 | <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p> | |
| 5e1c08eb C |
4964 | </div> |
| 4965 | </div> | |
| 5e1c08eb C |
4966 | </section> |
| 4967 | </div> | |
| 4968 | <div class="doc-examples"></div> | |
| 4969 | </div> | |
| 4970 | <div class="doc-row"> | |
| 4971 | <div class="doc-copy"> | |
| 4972 | <section class="swagger-responses"> | |
| 4973 | <div class="prop-row prop-group"> | |
| 4974 | <div class="prop-name"> | |
| 2963c343 RK |
4975 | <div class="prop-title">200 OK</div> |
| 4976 | <div class="prop-ref"> | |
| 4977 | <span class="json-schema-ref-array"> | |
| 4978 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
| 4979 | </span> | |
| 4980 | </div> | |
| 4981 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 4982 | </div> | |
| 4983 | <div class="prop-value"> | |
| 4984 | <p>successful operation</p> | |
| 4985 | </div> | |
| 4986 | </div> | |
| 4987 | <div class="prop-row prop-inner"> | |
| 4988 | <div class="prop-name">type</div> | |
| 4989 | <div class="prop-value"> | |
| 4990 | <span class="json-property-type"> | |
| 4991 | <span class="json-schema-ref-array"> | |
| 4992 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
| 4993 | </span> | |
| 4994 | </span> | |
| 4995 | <span class="json-property-range" title="Value limits"></span> | |
| 4996 | </div> | |
| 4997 | </div> | |
| 4998 | </section> | |
| 4999 | </div> | |
| 5000 | <div class="doc-examples"> | |
| 5001 | <h5>Response Content-Types: | |
| 5002 | <span>application/json</span> | |
| 5003 | </h5> | |
| 5004 | <section> | |
| 5005 | <h5>Response Example | |
| 5006 | <span>(200 OK)</span> | |
| 5007 | </h5> | |
| 5008 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 5009 | { | |
| 5010 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 5011 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 5012 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 5013 | <span class="hljs-attr">"ownerAccount"</span>: { | |
| 5014 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5015 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
| 5016 | } | |
| 5017 | } | |
| 5018 | ] | |
| 5019 | </code></pre> | |
| 5020 | <!-- </div> --> | |
| 5021 | </section> | |
| 5022 | </div> | |
| 5023 | </div> | |
| 5024 | </div> | |
| 5025 | <h1 id="tag-User" class="swagger-summary-tag" data-traverse-target="tag-User">User</h1> | |
| 5026 | <div id="operation--users-post" class="operation panel" data-traverse-target="operation--users-post"> | |
| 5027 | <!-- <section class="operation-tags row"> --> | |
| 5028 | <!-- <div class="doc-copy"> --> | |
| 5029 | <div class="operation-tags"> | |
| 5030 | <a class="label" href="#tag-User">User</a> | |
| 5031 | <!----> | |
| 5032 | </div> | |
| 5033 | <!-- </div> --> | |
| 5034 | <!-- </section> --> | |
| 5035 | <h2 class="operation-title"> | |
| 5036 | <span class="operation-summary">Creates user</span> | |
| 5037 | </h2> | |
| 5038 | <div class="doc-row"> | |
| 5039 | <div class="doc-copy"> | |
| 5040 | <section class="swagger-operation-path"> | |
| 5041 | <span class="operation-method">POST</span> | |
| 5042 | <span class="operation-path">/users</span> | |
| 5043 | </section> | |
| 5044 | </div> | |
| 5045 | </div> | |
| 5046 | <div class="doc-row"> | |
| 5047 | <div class="doc-copy"> | |
| 5048 | <section class="swagger-request-body"> | |
| 5049 | <div class="prop-row"> | |
| 5050 | <div class="prop-name"> | |
| 5051 | <div class="swagger-request-model"> | |
| 5052 | <span class=""> | |
| 5053 | <a class="json-schema-ref" href="#/definitions/AddUser">AddUser</a> | |
| 5054 | </span> | |
| 5055 | </div> | |
| 5056 | </div> | |
| 5057 | <div class="prop-value columns small-6"> | |
| 5058 | <!-- <div class="swagger-request-description"> --> | |
| 5059 | <p>User to create</p> | |
| 5060 | <!-- </div> --> | |
| 5061 | </div> | |
| 5062 | </div> | |
| 5063 | </section> | |
| 5064 | </div> | |
| 5065 | <div class="doc-examples"> | |
| 5066 | <section> | |
| 5067 | <h5>Request Content-Types: | |
| 5068 | <span>application/json</span> | |
| 5069 | </h5> | |
| 5070 | <h5>Request Example</h5> | |
| 5071 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 5072 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
| 5073 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
| 5074 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 5075 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
| 5076 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
| 5077 | } | |
| 5078 | </code></pre> | |
| 5079 | <!-- </div> --> | |
| 5080 | </section> | |
| 5081 | </div> | |
| 5082 | </div> | |
| 5083 | <div class="doc-row"> | |
| 5084 | <div class="doc-copy"> | |
| 5085 | <section class="swagger-responses"> | |
| 5086 | <div class="prop-row prop-group"> | |
| 5087 | <div class="prop-name"> | |
| 5088 | <div class="prop-title">200 OK</div> | |
| 5089 | <div class="prop-ref"> | |
| 5090 | <span class=""> | |
| 5091 | <a class="json-schema-ref" href="#/definitions/AddUserResponse">AddUserResponse</a> | |
| 5092 | </span> | |
| 5093 | </div> | |
| 5094 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 5e1c08eb C |
5095 | </div> |
| 5096 | <div class="prop-value"> | |
| 2963c343 | 5097 | <p>successful operation</p> |
| 5e1c08eb C |
5098 | </div> |
| 5099 | </div> | |
| 5100 | </section> | |
| 5101 | </div> | |
| 5102 | <div class="doc-examples"> | |
| 5103 | <h5>Response Content-Types: | |
| 5104 | <span>application/json</span> | |
| 5105 | </h5> | |
| 2963c343 RK |
5106 | <section> |
| 5107 | <h5>Response Example | |
| 5108 | <span>(200 OK)</span> | |
| 5109 | </h5> | |
| 5110 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 5111 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5112 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
| 5113 | } | |
| 5114 | </code></pre> | |
| 5115 | <!-- </div> --> | |
| 5116 | </section> | |
| 5e1c08eb C |
5117 | </div> |
| 5118 | </div> | |
| 94ff4c23 C |
5119 | <div class="doc-row"> |
| 5120 | <div class="doc-copy"> | |
| 5121 | <section class="swagger-request-security"> | |
| 5122 | <table class="table"> | |
| 5123 | <thead> | |
| 5124 | <tr> | |
| 5125 | <th class="swagger-request-security-schema"></th> | |
| 5126 | <th class="swagger-request-security-scopes"></th> | |
| 5127 | </tr> | |
| 5128 | </thead> | |
| 5129 | <tbody> | |
| 5130 | <tr> | |
| 5131 | <td> | |
| 5132 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 5133 | </td> | |
| 2963c343 RK |
5134 | <td> |
| 5135 | <a href="#security-definition-scope-admin">admin</a> | |
| 5136 | </td> | |
| 94ff4c23 C |
5137 | </tr> |
| 5138 | </tbody> | |
| 5139 | </table> | |
| 5140 | </section> | |
| 5141 | </div> | |
| 5142 | </div> | |
| 5e1c08eb | 5143 | </div> |
| 2963c343 | 5144 | <div id="operation--users-get" class="operation panel" data-traverse-target="operation--users-get"> |
| 5e1c08eb C |
5145 | <!-- <section class="operation-tags row"> --> |
| 5146 | <!-- <div class="doc-copy"> --> | |
| 5147 | <div class="operation-tags"> | |
| 2963c343 | 5148 | <a class="label" href="#tag-User">User</a> |
| 5e1c08eb C |
5149 | <!----> |
| 5150 | </div> | |
| 5151 | <!-- </div> --> | |
| 5152 | <!-- </section> --> | |
| 5153 | <h2 class="operation-title"> | |
| 2963c343 | 5154 | <span class="operation-summary">Get a list of users</span> |
| 5e1c08eb | 5155 | </h2> |
| 2963c343 RK |
5156 | <div class="doc-row"> |
| 5157 | <div class="doc-copy"> | |
| 5158 | <section class="swagger-operation-path"> | |
| 5159 | <span class="operation-method">GET</span> | |
| 5160 | <span class="operation-path">/users</span> | |
| 5161 | </section> | |
| 5162 | </div> | |
| 5163 | </div> | |
| 5e1c08eb | 5164 | <div class="doc-row"> |
| ab0ee6a1 C |
5165 | <div class="doc-copy"> |
| 5166 | <section class="swagger-request-params"> | |
| 5167 | <div class="prop-row prop-group"> | |
| 5168 | <div class="prop-name"> | |
| 330eaf12 C |
5169 | <div class="prop-title">start: |
| 5170 | <span class="prop-type"> | |
| 5171 | <span class="json-property-type">number</span> | |
| 5172 | <span class="json-property-range" title="Value limits"></span> | |
| 5173 | </span> | |
| 228e84aa | 5174 | </div> |
| 330eaf12 | 5175 | <div class="prop-subtitle"> in query </div> |
| ab0ee6a1 C |
5176 | </div> |
| 5177 | <div class="prop-value"> | |
| 330eaf12 | 5178 | <p>Offset</p> |
| ab0ee6a1 C |
5179 | </div> |
| 5180 | </div> | |
| ab0ee6a1 C |
5181 | <div class="prop-row prop-group"> |
| 5182 | <div class="prop-name"> | |
| 330eaf12 C |
5183 | <div class="prop-title">count: |
| 5184 | <span class="prop-type"> | |
| 5185 | <span class="json-property-type">number</span> | |
| 5186 | <span class="json-property-range" title="Value limits"></span> | |
| 5187 | </span> | |
| 228e84aa | 5188 | </div> |
| 330eaf12 | 5189 | <div class="prop-subtitle"> in query </div> |
| ab0ee6a1 C |
5190 | </div> |
| 5191 | <div class="prop-value"> | |
| 330eaf12 | 5192 | <p>Number of items</p> |
| ab0ee6a1 C |
5193 | </div> |
| 5194 | </div> | |
| ab0ee6a1 C |
5195 | <div class="prop-row prop-group"> |
| 5196 | <div class="prop-name"> | |
| 330eaf12 C |
5197 | <div class="prop-title">sort: |
| 5198 | <span class="prop-type"> | |
| 5199 | <span class="json-property-type">string</span> | |
| 5200 | <span class="json-property-range" title="Value limits"></span> | |
| 5201 | </span> | |
| 228e84aa | 5202 | </div> |
| 330eaf12 | 5203 | <div class="prop-subtitle"> in query </div> |
| ab0ee6a1 C |
5204 | </div> |
| 5205 | <div class="prop-value"> | |
| 330eaf12 | 5206 | <p>Sort column (-createdAt for example)</p> |
| ab0ee6a1 C |
5207 | </div> |
| 5208 | </div> | |
| ab0ee6a1 C |
5209 | </section> |
| 5210 | </div> | |
| 5e1c08eb C |
5211 | <div class="doc-examples"></div> |
| 5212 | </div> | |
| 5213 | <div class="doc-row"> | |
| 5214 | <div class="doc-copy"> | |
| 5215 | <section class="swagger-responses"> | |
| 5216 | <div class="prop-row prop-group"> | |
| 5217 | <div class="prop-name"> | |
| 5218 | <div class="prop-title">200 OK</div> | |
| 5219 | <div class="prop-ref"> | |
| 5220 | <span class="json-schema-ref-array"> | |
| 2963c343 | 5221 | <a class="json-schema-ref" href="#/definitions/User">User</a> |
| 5e1c08eb C |
5222 | </span> |
| 5223 | </div> | |
| 5224 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 5225 | </div> | |
| 5226 | <div class="prop-value"> | |
| 5227 | <p>successful operation</p> | |
| 5228 | </div> | |
| 5229 | </div> | |
| 228e84aa C |
5230 | <div class="prop-row prop-inner"> |
| 5231 | <div class="prop-name">type</div> | |
| 5232 | <div class="prop-value"> | |
| 5233 | <span class="json-property-type"> | |
| 5234 | <span class="json-schema-ref-array"> | |
| 2963c343 | 5235 | <a class="json-schema-ref" href="#/definitions/User">User</a> |
| 228e84aa C |
5236 | </span> |
| 5237 | </span> | |
| 5238 | <span class="json-property-range" title="Value limits"></span> | |
| 5239 | </div> | |
| 5240 | </div> | |
| 5e1c08eb C |
5241 | </section> |
| 5242 | </div> | |
| 5243 | <div class="doc-examples"> | |
| 5244 | <h5>Response Content-Types: | |
| 5245 | <span>application/json</span> | |
| 5246 | </h5> | |
| 5247 | <section> | |
| 5248 | <h5>Response Example | |
| 5249 | <span>(200 OK)</span> | |
| 5250 | </h5> | |
| 5251 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 5252 | { | |
| 5253 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2963c343 RK |
5254 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, |
| 5255 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 5256 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
| 5257 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
| 5258 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
| 5259 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
| 5e1c08eb | 5260 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
| 2963c343 RK |
5261 | <span class="hljs-attr">"account"</span>: { |
| 5262 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 5263 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5264 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 5265 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 5266 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 5267 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 5268 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 5269 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 5270 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5271 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5272 | <span class="hljs-attr">"avatar"</span>: { | |
| 5273 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 5274 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5275 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 5276 | } | |
| 5277 | }, | |
| 5278 | <span class="hljs-attr">"videoChannels"</span>: [ | |
| 5279 | { | |
| 5280 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 5281 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 5282 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 5283 | <span class="hljs-attr">"ownerAccount"</span>: { | |
| 5284 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5285 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
| 5286 | } | |
| 5287 | } | |
| 5288 | ] | |
| 5e1c08eb C |
5289 | } |
| 5290 | ] | |
| 5291 | </code></pre> | |
| 5292 | <!-- </div> --> | |
| 5293 | </section> | |
| 5294 | </div> | |
| 5295 | </div> | |
| 94ff4c23 C |
5296 | <div class="doc-row"> |
| 5297 | <div class="doc-copy"> | |
| 5298 | <section class="swagger-request-security"> | |
| 5299 | <table class="table"> | |
| 5300 | <thead> | |
| 5301 | <tr> | |
| 5302 | <th class="swagger-request-security-schema"></th> | |
| 5303 | <th class="swagger-request-security-scopes"></th> | |
| 5304 | </tr> | |
| 5305 | </thead> | |
| 5306 | <tbody> | |
| 5307 | <tr> | |
| 5308 | <td> | |
| 5309 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 5310 | </td> | |
| 5311 | <td> </td> | |
| 5312 | </tr> | |
| 5313 | </tbody> | |
| 5314 | </table> | |
| 5315 | </section> | |
| 5316 | </div> | |
| 5317 | </div> | |
| 5e1c08eb | 5318 | </div> |
| 2963c343 | 5319 | <div id="operation--users--id--delete" class="operation panel" data-traverse-target="operation--users--id--delete"> |
| 5e1c08eb C |
5320 | <!-- <section class="operation-tags row"> --> |
| 5321 | <!-- <div class="doc-copy"> --> | |
| 5322 | <div class="operation-tags"> | |
| 2963c343 | 5323 | <a class="label" href="#tag-User">User</a> |
| 5e1c08eb C |
5324 | <!----> |
| 5325 | </div> | |
| 5326 | <!-- </div> --> | |
| 5327 | <!-- </section> --> | |
| 5328 | <h2 class="operation-title"> | |
| 2963c343 | 5329 | <span class="operation-summary">Delete a user by its id</span> |
| 5e1c08eb C |
5330 | </h2> |
| 5331 | <div class="doc-row"> | |
| ab0ee6a1 | 5332 | <div class="doc-copy"> |
| 2963c343 RK |
5333 | <section class="swagger-operation-path"> |
| 5334 | <span class="operation-method">DELETE</span> | |
| 5335 | <span class="operation-path">/users/{id}</span> | |
| ab0ee6a1 C |
5336 | </section> |
| 5337 | </div> | |
| 5e1c08eb C |
5338 | </div> |
| 5339 | <div class="doc-row"> | |
| 5340 | <div class="doc-copy"> | |
| 2963c343 | 5341 | <section class="swagger-request-params"> |
| 5e1c08eb C |
5342 | <div class="prop-row prop-group"> |
| 5343 | <div class="prop-name"> | |
| 2963c343 RK |
5344 | <div class="prop-title">id: |
| 5345 | <span class="prop-type"> | |
| 5346 | <span class="json-property-type">number</span> | |
| 5347 | <span class="json-property-range" title="Value limits"></span> | |
| 5e1c08eb C |
5348 | </span> |
| 5349 | </div> | |
| 2963c343 RK |
5350 | <span class="json-property-required"></span> |
| 5351 | <div class="prop-subtitle"> in path </div> | |
| 5e1c08eb | 5352 | </div> |
| 228e84aa | 5353 | <div class="prop-value"> |
| 2963c343 | 5354 | <p>The user id</p> |
| 48dce1c9 C |
5355 | </div> |
| 5356 | </div> | |
| 5357 | </section> | |
| 5358 | </div> | |
| 2963c343 | 5359 | <div class="doc-examples"></div> |
| 48dce1c9 C |
5360 | </div> |
| 5361 | <div class="doc-row"> | |
| 5362 | <div class="doc-copy"> | |
| 5363 | <section class="swagger-responses"> | |
| 5364 | <div class="prop-row prop-group"> | |
| 5365 | <div class="prop-name"> | |
| cc918ac3 | 5366 | <div class="prop-title">204 No Content</div> |
| 5e1c08eb C |
5367 | </div> |
| 5368 | <div class="prop-value"> | |
| 330eaf12 | 5369 | <p>Successful operation</p> |
| 5e1c08eb C |
5370 | </div> |
| 5371 | </div> | |
| 5372 | </section> | |
| 5373 | </div> | |
| 5374 | <div class="doc-examples"> | |
| 5375 | <h5>Response Content-Types: | |
| 5376 | <span>application/json</span> | |
| 5377 | </h5> | |
| 5378 | </div> | |
| 5379 | </div> | |
| 94ff4c23 C |
5380 | <div class="doc-row"> |
| 5381 | <div class="doc-copy"> | |
| 5382 | <section class="swagger-request-security"> | |
| 5383 | <table class="table"> | |
| 5384 | <thead> | |
| 5385 | <tr> | |
| 5386 | <th class="swagger-request-security-schema"></th> | |
| 5387 | <th class="swagger-request-security-scopes"></th> | |
| 5388 | </tr> | |
| 5389 | </thead> | |
| 5390 | <tbody> | |
| 5391 | <tr> | |
| 5392 | <td> | |
| 5393 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 5394 | </td> | |
| 2963c343 RK |
5395 | <td> |
| 5396 | <a href="#security-definition-scope-admin">admin</a> | |
| 5397 | </td> | |
| 94ff4c23 C |
5398 | </tr> |
| 5399 | </tbody> | |
| 5400 | </table> | |
| 5401 | </section> | |
| 5402 | </div> | |
| 5403 | </div> | |
| 5e1c08eb | 5404 | </div> |
| 2963c343 | 5405 | <div id="operation--users--id--get" class="operation panel" data-traverse-target="operation--users--id--get"> |
| 5e1c08eb C |
5406 | <!-- <section class="operation-tags row"> --> |
| 5407 | <!-- <div class="doc-copy"> --> | |
| 5408 | <div class="operation-tags"> | |
| 2963c343 | 5409 | <a class="label" href="#tag-User">User</a> |
| 5e1c08eb C |
5410 | <!----> |
| 5411 | </div> | |
| 5412 | <!-- </div> --> | |
| 5413 | <!-- </section> --> | |
| 5414 | <h2 class="operation-title"> | |
| 2963c343 | 5415 | <span class="operation-summary">Get user by its id</span> |
| 5e1c08eb | 5416 | </h2> |
| 2963c343 RK |
5417 | <div class="doc-row"> |
| 5418 | <div class="doc-copy"> | |
| 5419 | <section class="swagger-operation-path"> | |
| 5420 | <span class="operation-method">GET</span> | |
| 5421 | <span class="operation-path">/users/{id}</span> | |
| 5422 | </section> | |
| 5423 | </div> | |
| 5424 | </div> | |
| 5e1c08eb C |
5425 | <div class="doc-row"> |
| 5426 | <div class="doc-copy"> | |
| 5427 | <section class="swagger-request-params"> | |
| 5428 | <div class="prop-row prop-group"> | |
| 5429 | <div class="prop-name"> | |
| 330eaf12 C |
5430 | <div class="prop-title">id: |
| 5431 | <span class="prop-type"> | |
| 2963c343 | 5432 | <span class="json-property-type">number</span> |
| 330eaf12 C |
5433 | <span class="json-property-range" title="Value limits"></span> |
| 5434 | </span> | |
| 5435 | </div> | |
| 5e1c08eb | 5436 | <span class="json-property-required"></span> |
| 228e84aa | 5437 | <div class="prop-subtitle"> in path </div> |
| 5e1c08eb C |
5438 | </div> |
| 5439 | <div class="prop-value"> | |
| 2963c343 | 5440 | <p>The user id</p> |
| 5e1c08eb C |
5441 | </div> |
| 5442 | </div> | |
| 5e1c08eb C |
5443 | </section> |
| 5444 | </div> | |
| 5445 | <div class="doc-examples"></div> | |
| 5446 | </div> | |
| 5447 | <div class="doc-row"> | |
| 5448 | <div class="doc-copy"> | |
| 5449 | <section class="swagger-responses"> | |
| 5450 | <div class="prop-row prop-group"> | |
| 5451 | <div class="prop-name"> | |
| 5452 | <div class="prop-title">200 OK</div> | |
| 5453 | <div class="prop-ref"> | |
| 5454 | <span class=""> | |
| 2963c343 | 5455 | <a class="json-schema-ref" href="#/definitions/User">User</a> |
| 5e1c08eb C |
5456 | </span> |
| 5457 | </div> | |
| 5458 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 5459 | </div> | |
| 5460 | <div class="prop-value"> | |
| 5461 | <p>successful operation</p> | |
| 5462 | </div> | |
| 5463 | </div> | |
| 5464 | </section> | |
| 5465 | </div> | |
| 5466 | <div class="doc-examples"> | |
| 5467 | <h5>Response Content-Types: | |
| 5468 | <span>application/json</span> | |
| 5469 | </h5> | |
| 5470 | <section> | |
| 5471 | <h5>Response Example | |
| 5472 | <span>(200 OK)</span> | |
| 5473 | </h5> | |
| 5474 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 2963c343 RK |
5475 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, |
| 5476 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
| 5477 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 5478 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
| 5479 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
| 5480 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
| 5481 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
| 5482 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5483 | <span class="hljs-attr">"account"</span>: { | |
| 5484 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| cc918ac3 | 5485 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, |
| 2963c343 RK |
5486 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, |
| 5487 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 5488 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 5489 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 5490 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 5491 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 5492 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5493 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5494 | <span class="hljs-attr">"avatar"</span>: { | |
| 5495 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 5496 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5497 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 5498 | } | |
| 5499 | }, | |
| 5500 | <span class="hljs-attr">"videoChannels"</span>: [ | |
| 5501 | { | |
| 5502 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 5503 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 5504 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 5505 | <span class="hljs-attr">"ownerAccount"</span>: { | |
| 5506 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5507 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
| 5508 | } | |
| 5509 | } | |
| 5510 | ] | |
| 5e1c08eb C |
5511 | } |
| 5512 | </code></pre> | |
| 5513 | <!-- </div> --> | |
| 5514 | </section> | |
| 5515 | </div> | |
| 5516 | </div> | |
| 2963c343 RK |
5517 | <div class="doc-row"> |
| 5518 | <div class="doc-copy"> | |
| 5519 | <section class="swagger-request-security"> | |
| 5520 | <table class="table"> | |
| 5521 | <thead> | |
| 5522 | <tr> | |
| 5523 | <th class="swagger-request-security-schema"></th> | |
| 5524 | <th class="swagger-request-security-scopes"></th> | |
| 5525 | </tr> | |
| 5526 | </thead> | |
| 5527 | <tbody> | |
| 5528 | <tr> | |
| 5529 | <td> | |
| 5530 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 5531 | </td> | |
| 5532 | <td> </td> | |
| 5533 | </tr> | |
| 5534 | </tbody> | |
| 5535 | </table> | |
| 5536 | </section> | |
| 5537 | </div> | |
| 5538 | </div> | |
| 5e1c08eb | 5539 | </div> |
| 2963c343 | 5540 | <div id="operation--users--id--put" class="operation panel" data-traverse-target="operation--users--id--put"> |
| 5e1c08eb C |
5541 | <!-- <section class="operation-tags row"> --> |
| 5542 | <!-- <div class="doc-copy"> --> | |
| 5543 | <div class="operation-tags"> | |
| 2963c343 | 5544 | <a class="label" href="#tag-User">User</a> |
| 5e1c08eb C |
5545 | <!----> |
| 5546 | </div> | |
| 5547 | <!-- </div> --> | |
| 5548 | <!-- </section> --> | |
| 5549 | <h2 class="operation-title"> | |
| 2963c343 | 5550 | <span class="operation-summary">Update user profile by its id</span> |
| 5e1c08eb | 5551 | </h2> |
| 2963c343 RK |
5552 | <div class="doc-row"> |
| 5553 | <div class="doc-copy"> | |
| 5554 | <section class="swagger-operation-path"> | |
| 5555 | <span class="operation-method">PUT</span> | |
| 5556 | <span class="operation-path">/users/{id}</span> | |
| 5557 | </section> | |
| 5558 | </div> | |
| 5559 | </div> | |
| 5e1c08eb C |
5560 | <div class="doc-row"> |
| 5561 | <div class="doc-copy"> | |
| 5562 | <section class="swagger-request-body"> | |
| 5563 | <div class="prop-row"> | |
| 5564 | <div class="prop-name"> | |
| 5565 | <div class="swagger-request-model"> | |
| 5566 | <span class=""> | |
| 2963c343 | 5567 | <a class="json-schema-ref" href="#/definitions/UpdateUser">UpdateUser</a> |
| 5e1c08eb C |
5568 | </span> |
| 5569 | </div> | |
| 5570 | </div> | |
| 5571 | <div class="prop-value columns small-6"> | |
| 228e84aa C |
5572 | <!-- <div class="swagger-request-description"> --> |
| 5573 | <p>undefined</p> | |
| 5e1c08eb C |
5574 | <!-- </div> --> |
| 5575 | </div> | |
| 5576 | </div> | |
| 5577 | </section> | |
| 5578 | <section class="swagger-request-params"> | |
| 5579 | <div class="prop-row prop-group"> | |
| 5580 | <div class="prop-name"> | |
| 330eaf12 C |
5581 | <div class="prop-title">id: |
| 5582 | <span class="prop-type"> | |
| 2963c343 | 5583 | <span class="json-property-type">number</span> |
| 330eaf12 C |
5584 | <span class="json-property-range" title="Value limits"></span> |
| 5585 | </span> | |
| 5586 | </div> | |
| 5e1c08eb | 5587 | <span class="json-property-required"></span> |
| 228e84aa | 5588 | <div class="prop-subtitle"> in path </div> |
| 5e1c08eb C |
5589 | </div> |
| 5590 | <div class="prop-value"> | |
| 2963c343 | 5591 | <p>The user id</p> |
| 5e1c08eb C |
5592 | </div> |
| 5593 | </div> | |
| 5e1c08eb C |
5594 | </section> |
| 5595 | </div> | |
| 5596 | <div class="doc-examples"> | |
| 5597 | <section> | |
| 5598 | <h5>Request Content-Types: | |
| 5599 | <span>application/json</span> | |
| 5600 | </h5> | |
| 5601 | <h5>Request Example</h5> | |
| 5602 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 2963c343 RK |
5603 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
| 5604 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 5605 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
| 5606 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
| 5e1c08eb C |
5607 | } |
| 5608 | </code></pre> | |
| 5609 | <!-- </div> --> | |
| 5610 | </section> | |
| 5611 | </div> | |
| 5612 | </div> | |
| 5613 | <div class="doc-row"> | |
| 5614 | <div class="doc-copy"> | |
| 5615 | <section class="swagger-responses"> | |
| 5616 | <div class="prop-row prop-group"> | |
| 5617 | <div class="prop-name"> | |
| 5618 | <div class="prop-title">204 No Content</div> | |
| 5619 | </div> | |
| 5620 | <div class="prop-value"> | |
| 330eaf12 | 5621 | <p>Successful operation</p> |
| 5e1c08eb C |
5622 | </div> |
| 5623 | </div> | |
| 5624 | </section> | |
| 5625 | </div> | |
| 5626 | <div class="doc-examples"> | |
| 5627 | <h5>Response Content-Types: | |
| 5628 | <span>application/json</span> | |
| 5629 | </h5> | |
| 5630 | </div> | |
| 5631 | </div> | |
| 94ff4c23 C |
5632 | <div class="doc-row"> |
| 5633 | <div class="doc-copy"> | |
| 5634 | <section class="swagger-request-security"> | |
| 5635 | <table class="table"> | |
| 5636 | <thead> | |
| 5637 | <tr> | |
| 5638 | <th class="swagger-request-security-schema"></th> | |
| 5639 | <th class="swagger-request-security-scopes"></th> | |
| 5640 | </tr> | |
| 5641 | </thead> | |
| 5642 | <tbody> | |
| 5643 | <tr> | |
| 5644 | <td> | |
| 5645 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 5646 | </td> | |
| 5647 | <td> </td> | |
| 5648 | </tr> | |
| 5649 | </tbody> | |
| 5650 | </table> | |
| 5651 | </section> | |
| 5652 | </div> | |
| 5653 | </div> | |
| 5e1c08eb | 5654 | </div> |
| 2963c343 | 5655 | <div id="operation--users-me-get" class="operation panel" data-traverse-target="operation--users-me-get"> |
| 5e1c08eb C |
5656 | <!-- <section class="operation-tags row"> --> |
| 5657 | <!-- <div class="doc-copy"> --> | |
| 5658 | <div class="operation-tags"> | |
| 2963c343 | 5659 | <a class="label" href="#tag-User">User</a> |
| 5e1c08eb C |
5660 | <!----> |
| 5661 | </div> | |
| 5662 | <!-- </div> --> | |
| 5663 | <!-- </section> --> | |
| 5664 | <h2 class="operation-title"> | |
| 2963c343 | 5665 | <span class="operation-summary">Get current user information</span> |
| 5e1c08eb C |
5666 | </h2> |
| 5667 | <div class="doc-row"> | |
| 5668 | <div class="doc-copy"> | |
| 2963c343 RK |
5669 | <section class="swagger-operation-path"> |
| 5670 | <span class="operation-method">GET</span> | |
| 5671 | <span class="operation-path">/users/me</span> | |
| 5e1c08eb C |
5672 | </section> |
| 5673 | </div> | |
| 2963c343 RK |
5674 | </div> |
| 5675 | <div class="doc-row"> | |
| 5676 | <div class="doc-copy"> </div> | |
| 5e1c08eb C |
5677 | <div class="doc-examples"></div> |
| 5678 | </div> | |
| 5679 | <div class="doc-row"> | |
| 5680 | <div class="doc-copy"> | |
| 5681 | <section class="swagger-responses"> | |
| 5682 | <div class="prop-row prop-group"> | |
| 5683 | <div class="prop-name"> | |
| 2963c343 RK |
5684 | <div class="prop-title">200 OK</div> |
| 5685 | <div class="prop-ref"> | |
| 5686 | <span class="json-schema-ref-array"> | |
| 5687 | <a class="json-schema-ref" href="#/definitions/User">User</a> | |
| 5688 | </span> | |
| 5689 | </div> | |
| 5690 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 5e1c08eb C |
5691 | </div> |
| 5692 | <div class="prop-value"> | |
| 2963c343 RK |
5693 | <p>successful operation</p> |
| 5694 | </div> | |
| 5695 | </div> | |
| 5696 | <div class="prop-row prop-inner"> | |
| 5697 | <div class="prop-name">type</div> | |
| 5698 | <div class="prop-value"> | |
| 5699 | <span class="json-property-type"> | |
| 5700 | <span class="json-schema-ref-array"> | |
| 5701 | <a class="json-schema-ref" href="#/definitions/User">User</a> | |
| 5702 | </span> | |
| 5703 | </span> | |
| 5704 | <span class="json-property-range" title="Value limits"></span> | |
| 5e1c08eb C |
5705 | </div> |
| 5706 | </div> | |
| 5707 | </section> | |
| 5708 | </div> | |
| 5709 | <div class="doc-examples"> | |
| 5710 | <h5>Response Content-Types: | |
| 5711 | <span>application/json</span> | |
| 5712 | </h5> | |
| 2963c343 RK |
5713 | <section> |
| 5714 | <h5>Response Example | |
| 5715 | <span>(200 OK)</span> | |
| 5716 | </h5> | |
| 5717 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 5718 | { | |
| 5719 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5720 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
| 5721 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 5722 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
| 5723 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
| 5724 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
| 5725 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
| 5726 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5727 | <span class="hljs-attr">"account"</span>: { | |
| 5728 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 5729 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5730 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 5731 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 5732 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 5733 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 5734 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 5735 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 5736 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5737 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5738 | <span class="hljs-attr">"avatar"</span>: { | |
| 5739 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 5740 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 5741 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 5742 | } | |
| 5743 | }, | |
| 5744 | <span class="hljs-attr">"videoChannels"</span>: [ | |
| 5745 | { | |
| 5746 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 5747 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 5748 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 5749 | <span class="hljs-attr">"ownerAccount"</span>: { | |
| 5750 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5751 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
| 5752 | } | |
| 5753 | } | |
| 5754 | ] | |
| 5755 | } | |
| 5756 | ] | |
| 5757 | </code></pre> | |
| 5758 | <!-- </div> --> | |
| 5759 | </section> | |
| 5e1c08eb C |
5760 | </div> |
| 5761 | </div> | |
| 94ff4c23 C |
5762 | <div class="doc-row"> |
| 5763 | <div class="doc-copy"> | |
| 5764 | <section class="swagger-request-security"> | |
| 5765 | <table class="table"> | |
| 5766 | <thead> | |
| 5767 | <tr> | |
| 5768 | <th class="swagger-request-security-schema"></th> | |
| 5769 | <th class="swagger-request-security-scopes"></th> | |
| 5770 | </tr> | |
| 5771 | </thead> | |
| 5772 | <tbody> | |
| 5773 | <tr> | |
| 5774 | <td> | |
| 5775 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 5776 | </td> | |
| 5777 | <td> </td> | |
| 5778 | </tr> | |
| 5779 | </tbody> | |
| 5780 | </table> | |
| 5781 | </section> | |
| 5782 | </div> | |
| 5783 | </div> | |
| 5e1c08eb | 5784 | </div> |
| 2963c343 | 5785 | <div id="operation--users-me-put" class="operation panel" data-traverse-target="operation--users-me-put"> |
| cc918ac3 C |
5786 | <!-- <section class="operation-tags row"> --> |
| 5787 | <!-- <div class="doc-copy"> --> | |
| 5788 | <div class="operation-tags"> | |
| 2963c343 | 5789 | <a class="label" href="#tag-User">User</a> |
| cc918ac3 C |
5790 | <!----> |
| 5791 | </div> | |
| 5792 | <!-- </div> --> | |
| 5793 | <!-- </section> --> | |
| 5794 | <h2 class="operation-title"> | |
| 2963c343 | 5795 | <span class="operation-summary">Update current user information</span> |
| cc918ac3 C |
5796 | </h2> |
| 5797 | <div class="doc-row"> | |
| 5798 | <div class="doc-copy"> | |
| 2963c343 RK |
5799 | <section class="swagger-operation-path"> |
| 5800 | <span class="operation-method">PUT</span> | |
| 5801 | <span class="operation-path">/users/me</span> | |
| cc918ac3 C |
5802 | </section> |
| 5803 | </div> | |
| cc918ac3 C |
5804 | </div> |
| 5805 | <div class="doc-row"> | |
| 5806 | <div class="doc-copy"> | |
| 2963c343 RK |
5807 | <section class="swagger-request-body"> |
| 5808 | <div class="prop-row"> | |
| cc918ac3 | 5809 | <div class="prop-name"> |
| 2963c343 | 5810 | <div class="swagger-request-model"> |
| cc918ac3 | 5811 | <span class=""> |
| 2963c343 | 5812 | <a class="json-schema-ref" href="#/definitions/UpdateMe">UpdateMe</a> |
| cc918ac3 C |
5813 | </span> |
| 5814 | </div> | |
| cc918ac3 | 5815 | </div> |
| 2963c343 RK |
5816 | <div class="prop-value columns small-6"> |
| 5817 | <!-- <div class="swagger-request-description"> --> | |
| 5818 | <p>undefined</p> | |
| 5819 | <!-- </div> --> | |
| cc918ac3 C |
5820 | </div> |
| 5821 | </div> | |
| 5822 | </section> | |
| 5823 | </div> | |
| 5824 | <div class="doc-examples"> | |
| cc918ac3 | 5825 | <section> |
| 2963c343 RK |
5826 | <h5>Request Content-Types: |
| 5827 | <span>application/json</span> | |
| cc918ac3 | 5828 | </h5> |
| 2963c343 | 5829 | <h5>Request Example</h5> |
| cc918ac3 | 5830 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ |
| 2963c343 RK |
5831 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, |
| 5832 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 5833 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"string"</span>, | |
| 5834 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"string"</span> | |
| cc918ac3 C |
5835 | } |
| 5836 | </code></pre> | |
| 5837 | <!-- </div> --> | |
| 5838 | </section> | |
| 5839 | </div> | |
| 5840 | </div> | |
| 2963c343 RK |
5841 | <div class="doc-row"> |
| 5842 | <div class="doc-copy"> | |
| 5843 | <section class="swagger-responses"> | |
| 5844 | <div class="prop-row prop-group"> | |
| 5845 | <div class="prop-name"> | |
| 5846 | <div class="prop-title">204 No Content</div> | |
| 5847 | </div> | |
| 5848 | <div class="prop-value"> | |
| 5849 | <p>Successful operation</p> | |
| 5850 | </div> | |
| 5851 | </div> | |
| 5852 | </section> | |
| 5853 | </div> | |
| 5854 | <div class="doc-examples"> | |
| 5855 | <h5>Response Content-Types: | |
| 5856 | <span>application/json</span> | |
| 5857 | </h5> | |
| 5858 | </div> | |
| 5859 | </div> | |
| 5860 | <div class="doc-row"> | |
| 5861 | <div class="doc-copy"> | |
| 5862 | <section class="swagger-request-security"> | |
| 5863 | <table class="table"> | |
| 5864 | <thead> | |
| 5865 | <tr> | |
| 5866 | <th class="swagger-request-security-schema"></th> | |
| 5867 | <th class="swagger-request-security-scopes"></th> | |
| 5868 | </tr> | |
| 5869 | </thead> | |
| 5870 | <tbody> | |
| 5871 | <tr> | |
| 5872 | <td> | |
| 5873 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 5874 | </td> | |
| 5875 | <td> </td> | |
| 5876 | </tr> | |
| 5877 | </tbody> | |
| 5878 | </table> | |
| 5879 | </section> | |
| 5880 | </div> | |
| 5881 | </div> | |
| cc918ac3 | 5882 | </div> |
| 2963c343 | 5883 | <div id="operation--users-me-video-quota-used-get" class="operation panel" data-traverse-target="operation--users-me-video-quota-used-get"> |
| cc918ac3 C |
5884 | <!-- <section class="operation-tags row"> --> |
| 5885 | <!-- <div class="doc-copy"> --> | |
| 5886 | <div class="operation-tags"> | |
| 2963c343 | 5887 | <a class="label" href="#tag-User">User</a> |
| cc918ac3 C |
5888 | <!----> |
| 5889 | </div> | |
| 5890 | <!-- </div> --> | |
| 5891 | <!-- </section> --> | |
| 5892 | <h2 class="operation-title"> | |
| 2963c343 | 5893 | <span class="operation-summary">Get current user used quota</span> |
| cc918ac3 C |
5894 | </h2> |
| 5895 | <div class="doc-row"> | |
| 5896 | <div class="doc-copy"> | |
| 2963c343 RK |
5897 | <section class="swagger-operation-path"> |
| 5898 | <span class="operation-method">GET</span> | |
| 5899 | <span class="operation-path">/users/me/video-quota-used</span> | |
| cc918ac3 C |
5900 | </section> |
| 5901 | </div> | |
| 2963c343 RK |
5902 | </div> |
| 5903 | <div class="doc-row"> | |
| 5904 | <div class="doc-copy"> </div> | |
| cc918ac3 C |
5905 | <div class="doc-examples"></div> |
| 5906 | </div> | |
| 5907 | <div class="doc-row"> | |
| 5908 | <div class="doc-copy"> | |
| 5909 | <section class="swagger-responses"> | |
| 5910 | <div class="prop-row prop-group"> | |
| 5911 | <div class="prop-name"> | |
| 5912 | <div class="prop-title">200 OK</div> | |
| 2963c343 | 5913 | <div class="prop-ref"></div> |
| cc918ac3 C |
5914 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> |
| 5915 | </div> | |
| 5916 | <div class="prop-value"> | |
| 5917 | <p>successful operation</p> | |
| 5918 | </div> | |
| 5919 | </div> | |
| 5920 | <div class="prop-row prop-inner"> | |
| 5921 | <div class="prop-name">type</div> | |
| 5922 | <div class="prop-value"> | |
| 2963c343 | 5923 | <span class="json-property-type">number</span> |
| cc918ac3 C |
5924 | <span class="json-property-range" title="Value limits"></span> |
| 5925 | </div> | |
| 5926 | </div> | |
| 5927 | </section> | |
| 5928 | </div> | |
| 5929 | <div class="doc-examples"> | |
| 5930 | <h5>Response Content-Types: | |
| 5931 | <span>application/json</span> | |
| 5932 | </h5> | |
| 5933 | <section> | |
| 5934 | <h5>Response Example | |
| 5935 | <span>(200 OK)</span> | |
| 5936 | </h5> | |
| 2963c343 | 5937 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">"number"</span> |
| cc918ac3 C |
5938 | </code></pre> |
| 5939 | <!-- </div> --> | |
| 5940 | </section> | |
| 5941 | </div> | |
| 5942 | </div> | |
| 2963c343 RK |
5943 | <div class="doc-row"> |
| 5944 | <div class="doc-copy"> | |
| 5945 | <section class="swagger-request-security"> | |
| 5946 | <table class="table"> | |
| 5947 | <thead> | |
| 5948 | <tr> | |
| 5949 | <th class="swagger-request-security-schema"></th> | |
| 5950 | <th class="swagger-request-security-scopes"></th> | |
| 5951 | </tr> | |
| 5952 | </thead> | |
| 5953 | <tbody> | |
| 5954 | <tr> | |
| 5955 | <td> | |
| 5956 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 5957 | </td> | |
| 5958 | <td> </td> | |
| 5959 | </tr> | |
| 5960 | </tbody> | |
| 5961 | </table> | |
| 5962 | </section> | |
| 5963 | </div> | |
| 5964 | </div> | |
| cc918ac3 | 5965 | </div> |
| 2963c343 | 5966 | <div id="operation--users-me-videos--videoId--rating-get" class="operation panel" data-traverse-target="operation--users-me-videos--videoId--rating-get"> |
| 5e1c08eb C |
5967 | <!-- <section class="operation-tags row"> --> |
| 5968 | <!-- <div class="doc-copy"> --> | |
| 5969 | <div class="operation-tags"> | |
| 2963c343 | 5970 | <a class="label" href="#tag-User">User</a> |
| 5e1c08eb C |
5971 | <!----> |
| 5972 | </div> | |
| 5973 | <!-- </div> --> | |
| 5974 | <!-- </section> --> | |
| 5975 | <h2 class="operation-title"> | |
| 2963c343 | 5976 | <span class="operation-summary">Get rating of video by its id, among those of the current user</span> |
| 5e1c08eb | 5977 | </h2> |
| 2963c343 RK |
5978 | <div class="doc-row"> |
| 5979 | <div class="doc-copy"> | |
| 5980 | <section class="swagger-operation-path"> | |
| 5981 | <span class="operation-method">GET</span> | |
| 5982 | <span class="operation-path">/users/me/videos/{videoId}/rating</span> | |
| 5983 | </section> | |
| 5984 | </div> | |
| 5985 | </div> | |
| 5e1c08eb C |
5986 | <div class="doc-row"> |
| 5987 | <div class="doc-copy"> | |
| 5988 | <section class="swagger-request-params"> | |
| 5989 | <div class="prop-row prop-group"> | |
| 5990 | <div class="prop-name"> | |
| 2963c343 | 5991 | <div class="prop-title">videoId: |
| 330eaf12 C |
5992 | <span class="prop-type"> |
| 5993 | <span class="json-property-type">string</span> | |
| 5994 | <span class="json-property-range" title="Value limits"></span> | |
| 5995 | </span> | |
| 5996 | </div> | |
| ab0ee6a1 | 5997 | <span class="json-property-required"></span> |
| 228e84aa | 5998 | <div class="prop-subtitle"> in path </div> |
| ab0ee6a1 C |
5999 | </div> |
| 6000 | <div class="prop-value"> | |
| 2963c343 | 6001 | <p>The video id </p> |
| ab0ee6a1 C |
6002 | </div> |
| 6003 | </div> | |
| 5e1c08eb C |
6004 | </section> |
| 6005 | </div> | |
| 6006 | <div class="doc-examples"></div> | |
| 6007 | </div> | |
| 6008 | <div class="doc-row"> | |
| 6009 | <div class="doc-copy"> | |
| 6010 | <section class="swagger-responses"> | |
| 6011 | <div class="prop-row prop-group"> | |
| 6012 | <div class="prop-name"> | |
| 6013 | <div class="prop-title">200 OK</div> | |
| 6014 | <div class="prop-ref"> | |
| 6015 | <span class=""> | |
| 2963c343 | 6016 | <a class="json-schema-ref" href="#/definitions/GetMeVideoRating">GetMeVideoRating</a> |
| 5e1c08eb C |
6017 | </span> |
| 6018 | </div> | |
| 6019 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 6020 | </div> | |
| 6021 | <div class="prop-value"> | |
| 6022 | <p>successful operation</p> | |
| 6023 | </div> | |
| 6024 | </div> | |
| 6025 | </section> | |
| 6026 | </div> | |
| 6027 | <div class="doc-examples"> | |
| 6028 | <h5>Response Content-Types: | |
| 6029 | <span>application/json</span> | |
| 6030 | </h5> | |
| 6031 | <section> | |
| 6032 | <h5>Response Example | |
| 6033 | <span>(200 OK)</span> | |
| 6034 | </h5> | |
| ab0ee6a1 | 6035 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ |
| 2963c343 RK |
6036 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
| 6037 | <span class="hljs-attr">"rating"</span>: <span class="hljs-string">"number"</span> | |
| ab0ee6a1 C |
6038 | } |
| 6039 | </code></pre> | |
| 5e1c08eb C |
6040 | <!-- </div> --> |
| 6041 | </section> | |
| 6042 | </div> | |
| 6043 | </div> | |
| 2963c343 RK |
6044 | <div class="doc-row"> |
| 6045 | <div class="doc-copy"> | |
| 6046 | <section class="swagger-request-security"> | |
| 6047 | <table class="table"> | |
| 6048 | <thead> | |
| 6049 | <tr> | |
| 6050 | <th class="swagger-request-security-schema"></th> | |
| 6051 | <th class="swagger-request-security-scopes"></th> | |
| 6052 | </tr> | |
| 6053 | </thead> | |
| 6054 | <tbody> | |
| 6055 | <tr> | |
| 6056 | <td> | |
| 6057 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 6058 | </td> | |
| 6059 | <td> </td> | |
| 6060 | </tr> | |
| 6061 | </tbody> | |
| 6062 | </table> | |
| 6063 | </section> | |
| 6064 | </div> | |
| 6065 | </div> | |
| 5e1c08eb | 6066 | </div> |
| 2963c343 | 6067 | <div id="operation--users-me-videos-get" class="operation panel" data-traverse-target="operation--users-me-videos-get"> |
| 5e1c08eb C |
6068 | <!-- <section class="operation-tags row"> --> |
| 6069 | <!-- <div class="doc-copy"> --> | |
| 6070 | <div class="operation-tags"> | |
| 2963c343 | 6071 | <a class="label" href="#tag-User">User</a> |
| 5e1c08eb C |
6072 | <!----> |
| 6073 | </div> | |
| 6074 | <!-- </div> --> | |
| 6075 | <!-- </section> --> | |
| 6076 | <h2 class="operation-title"> | |
| 2963c343 | 6077 | <span class="operation-summary">Get videos of the current user</span> |
| 5e1c08eb | 6078 | </h2> |
| 2963c343 RK |
6079 | <div class="doc-row"> |
| 6080 | <div class="doc-copy"> | |
| 6081 | <section class="swagger-operation-path"> | |
| 6082 | <span class="operation-method">GET</span> | |
| 6083 | <span class="operation-path">/users/me/videos</span> | |
| 6084 | </section> | |
| 6085 | </div> | |
| 6086 | </div> | |
| 5e1c08eb C |
6087 | <div class="doc-row"> |
| 6088 | <div class="doc-copy"> | |
| 6089 | <section class="swagger-request-params"> | |
| 6090 | <div class="prop-row prop-group"> | |
| 6091 | <div class="prop-name"> | |
| 2963c343 | 6092 | <div class="prop-title">start: |
| 330eaf12 | 6093 | <span class="prop-type"> |
| 2963c343 | 6094 | <span class="json-property-type">number</span> |
| 330eaf12 C |
6095 | <span class="json-property-range" title="Value limits"></span> |
| 6096 | </span> | |
| 6097 | </div> | |
| 2963c343 RK |
6098 | <div class="prop-subtitle"> in query </div> |
| 6099 | </div> | |
| 6100 | <div class="prop-value"> | |
| 6101 | <p>Offset</p> | |
| 6102 | </div> | |
| 6103 | </div> | |
| 6104 | <div class="prop-row prop-group"> | |
| 6105 | <div class="prop-name"> | |
| 6106 | <div class="prop-title">count: | |
| 6107 | <span class="prop-type"> | |
| 6108 | <span class="json-property-type">number</span> | |
| 6109 | <span class="json-property-range" title="Value limits"></span> | |
| 6110 | </span> | |
| 6111 | </div> | |
| 6112 | <div class="prop-subtitle"> in query </div> | |
| 6113 | </div> | |
| 6114 | <div class="prop-value"> | |
| 6115 | <p>Number of items</p> | |
| 6116 | </div> | |
| 6117 | </div> | |
| 6118 | <div class="prop-row prop-group"> | |
| 6119 | <div class="prop-name"> | |
| 6120 | <div class="prop-title">sort: | |
| 6121 | <span class="prop-type"> | |
| 6122 | <span class="json-property-type">string</span> | |
| 6123 | <span class="json-property-range" title="Value limits"></span> | |
| 6124 | </span> | |
| 6125 | </div> | |
| 6126 | <div class="prop-subtitle"> in query </div> | |
| 5e1c08eb C |
6127 | </div> |
| 6128 | <div class="prop-value"> | |
| 2963c343 | 6129 | <p>Sort column (-createdAt for example)</p> |
| 5e1c08eb C |
6130 | </div> |
| 6131 | </div> | |
| 5e1c08eb C |
6132 | </section> |
| 6133 | </div> | |
| 6134 | <div class="doc-examples"></div> | |
| 6135 | </div> | |
| 6136 | <div class="doc-row"> | |
| 6137 | <div class="doc-copy"> | |
| 6138 | <section class="swagger-responses"> | |
| 6139 | <div class="prop-row prop-group"> | |
| 6140 | <div class="prop-name"> | |
| 6141 | <div class="prop-title">200 OK</div> | |
| ab0ee6a1 | 6142 | <div class="prop-ref"> |
| 2963c343 RK |
6143 | <span class="json-schema-ref-array"> |
| 6144 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
| ab0ee6a1 C |
6145 | </span> |
| 6146 | </div> | |
| 6147 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 5e1c08eb C |
6148 | </div> |
| 6149 | <div class="prop-value"> | |
| 6150 | <p>successful operation</p> | |
| 6151 | </div> | |
| 6152 | </div> | |
| 2963c343 RK |
6153 | <div class="prop-row prop-inner"> |
| 6154 | <div class="prop-name">type</div> | |
| 6155 | <div class="prop-value"> | |
| 6156 | <span class="json-property-type"> | |
| 6157 | <span class="json-schema-ref-array"> | |
| 6158 | <a class="json-schema-ref" href="#/definitions/Video">Video</a> | |
| 6159 | </span> | |
| 6160 | </span> | |
| 6161 | <span class="json-property-range" title="Value limits"></span> | |
| 6162 | </div> | |
| 6163 | </div> | |
| 5e1c08eb C |
6164 | </section> |
| 6165 | </div> | |
| 6166 | <div class="doc-examples"> | |
| 6167 | <h5>Response Content-Types: | |
| 6168 | <span>application/json</span> | |
| 6169 | </h5> | |
| ab0ee6a1 C |
6170 | <section> |
| 6171 | <h5>Response Example | |
| 6172 | <span>(200 OK)</span> | |
| 6173 | </h5> | |
| 2963c343 RK |
6174 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ |
| 6175 | { | |
| ab0ee6a1 | 6176 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, |
| 2963c343 | 6177 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, |
| ab0ee6a1 | 6178 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
| 2963c343 | 6179 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, |
| ab0ee6a1 | 6180 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, |
| 2963c343 RK |
6181 | <span class="hljs-attr">"category"</span>: { |
| 6182 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 6183 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 6184 | }, | |
| 6185 | <span class="hljs-attr">"licence"</span>: { | |
| 6186 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 6187 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 6188 | }, | |
| 6189 | <span class="hljs-attr">"language"</span>: { | |
| 6190 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
| 6191 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 6192 | }, | |
| 6193 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, | |
| 6194 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 6195 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 6196 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 6197 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 6198 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, | |
| 6199 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
| 6200 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
| 6201 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 6202 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 6203 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 6204 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, | |
| ab0ee6a1 | 6205 | <span class="hljs-attr">"account"</span>: { |
| 2963c343 | 6206 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, |
| ab0ee6a1 | 6207 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, |
| ab0ee6a1 | 6208 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, |
| ab0ee6a1 | 6209 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, |
| ab0ee6a1 C |
6210 | <span class="hljs-attr">"avatar"</span>: { |
| 6211 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 6212 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6213 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 6214 | } | |
| 6215 | } | |
| 6216 | } | |
| 2963c343 | 6217 | ] |
| ab0ee6a1 C |
6218 | </code></pre> |
| 6219 | <!-- </div> --> | |
| 6220 | </section> | |
| 5e1c08eb C |
6221 | </div> |
| 6222 | </div> | |
| 94ff4c23 C |
6223 | <div class="doc-row"> |
| 6224 | <div class="doc-copy"> | |
| 6225 | <section class="swagger-request-security"> | |
| 6226 | <table class="table"> | |
| 6227 | <thead> | |
| 6228 | <tr> | |
| 6229 | <th class="swagger-request-security-schema"></th> | |
| 6230 | <th class="swagger-request-security-scopes"></th> | |
| 6231 | </tr> | |
| 6232 | </thead> | |
| 6233 | <tbody> | |
| 6234 | <tr> | |
| 6235 | <td> | |
| 6236 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 6237 | </td> | |
| 6238 | <td> </td> | |
| 6239 | </tr> | |
| 6240 | </tbody> | |
| 6241 | </table> | |
| 6242 | </section> | |
| 6243 | </div> | |
| 6244 | </div> | |
| 5e1c08eb | 6245 | </div> |
| 2963c343 | 6246 | <div id="operation--users-register-post" class="operation panel" data-traverse-target="operation--users-register-post"> |
| 5e1c08eb C |
6247 | <!-- <section class="operation-tags row"> --> |
| 6248 | <!-- <div class="doc-copy"> --> | |
| 6249 | <div class="operation-tags"> | |
| 2963c343 | 6250 | <a class="label" href="#tag-User">User</a> |
| 5e1c08eb C |
6251 | <!----> |
| 6252 | </div> | |
| 6253 | <!-- </div> --> | |
| 6254 | <!-- </section> --> | |
| 6255 | <h2 class="operation-title"> | |
| 2963c343 | 6256 | <span class="operation-summary">Register a user</span> |
| 5e1c08eb C |
6257 | </h2> |
| 6258 | <div class="doc-row"> | |
| 6259 | <div class="doc-copy"> | |
| 2963c343 RK |
6260 | <section class="swagger-operation-path"> |
| 6261 | <span class="operation-method">POST</span> | |
| 6262 | <span class="operation-path">/users/register</span> | |
| 6263 | </section> | |
| 6264 | </div> | |
| 6265 | </div> | |
| 6266 | <div class="doc-row"> | |
| 6267 | <div class="doc-copy"> | |
| 6268 | <section class="swagger-request-body"> | |
| 6269 | <div class="prop-row"> | |
| 5e1c08eb | 6270 | <div class="prop-name"> |
| 2963c343 RK |
6271 | <div class="swagger-request-model"> |
| 6272 | <span class=""> | |
| 6273 | <a class="json-schema-ref" href="#/definitions/RegisterUser">RegisterUser</a> | |
| 330eaf12 C |
6274 | </span> |
| 6275 | </div> | |
| 5e1c08eb | 6276 | </div> |
| 2963c343 RK |
6277 | <div class="prop-value columns small-6"> |
| 6278 | <!-- <div class="swagger-request-description"> --> | |
| 6279 | <p>undefined</p> | |
| 6280 | <!-- </div> --> | |
| 5e1c08eb C |
6281 | </div> |
| 6282 | </div> | |
| 5e1c08eb C |
6283 | </section> |
| 6284 | </div> | |
| 2963c343 RK |
6285 | <div class="doc-examples"> |
| 6286 | <section> | |
| 6287 | <h5>Request Content-Types: | |
| 6288 | <span>application/json</span> | |
| 6289 | </h5> | |
| 6290 | <h5>Request Example</h5> | |
| 6291 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 6292 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
| 6293 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
| 6294 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span> | |
| 6295 | } | |
| 6296 | </code></pre> | |
| 6297 | <!-- </div> --> | |
| 6298 | </section> | |
| 6299 | </div> | |
| 5e1c08eb C |
6300 | </div> |
| 6301 | <div class="doc-row"> | |
| 6302 | <div class="doc-copy"> | |
| 6303 | <section class="swagger-responses"> | |
| 6304 | <div class="prop-row prop-group"> | |
| 6305 | <div class="prop-name"> | |
| 2963c343 | 6306 | <div class="prop-title">204 No Content</div> |
| 5e1c08eb C |
6307 | </div> |
| 6308 | <div class="prop-value"> | |
| 2963c343 | 6309 | <p>Successful operation</p> |
| 5e1c08eb C |
6310 | </div> |
| 6311 | </div> | |
| 6312 | </section> | |
| 6313 | </div> | |
| 6314 | <div class="doc-examples"> | |
| 6315 | <h5>Response Content-Types: | |
| 6316 | <span>application/json</span> | |
| 6317 | </h5> | |
| 5e1c08eb C |
6318 | </div> |
| 6319 | </div> | |
| 6320 | </div> | |
| 2963c343 | 6321 | <div id="operation--users-me-avatar-pick-post" class="operation panel" data-traverse-target="operation--users-me-avatar-pick-post"> |
| 5e1c08eb C |
6322 | <!-- <section class="operation-tags row"> --> |
| 6323 | <!-- <div class="doc-copy"> --> | |
| 6324 | <div class="operation-tags"> | |
| 2963c343 | 6325 | <a class="label" href="#tag-User">User</a> |
| 5e1c08eb C |
6326 | <!----> |
| 6327 | </div> | |
| 6328 | <!-- </div> --> | |
| 6329 | <!-- </section> --> | |
| 6330 | <h2 class="operation-title"> | |
| 2963c343 | 6331 | <span class="operation-summary">Update current user avatar</span> |
| 5e1c08eb C |
6332 | </h2> |
| 6333 | <div class="doc-row"> | |
| 6334 | <div class="doc-copy"> | |
| 2963c343 RK |
6335 | <section class="swagger-operation-path"> |
| 6336 | <span class="operation-method">POST</span> | |
| 6337 | <span class="operation-path">/users/me/avatar/pick</span> | |
| 6338 | </section> | |
| 6339 | </div> | |
| 6340 | </div> | |
| 6341 | <div class="doc-row"> | |
| 6342 | <div class="doc-copy"> | |
| 6343 | <section class="swagger-request-params"> | |
| 5e1c08eb C |
6344 | <div class="prop-row prop-group"> |
| 6345 | <div class="prop-name"> | |
| 2963c343 | 6346 | <div class="prop-title">avatarfile: |
| 330eaf12 | 6347 | <span class="prop-type"> |
| 2963c343 | 6348 | <span class="json-property-type">file</span> |
| 330eaf12 C |
6349 | <span class="json-property-range" title="Value limits"></span> |
| 6350 | </span> | |
| 6351 | </div> | |
| 2963c343 | 6352 | <div class="prop-subtitle"> in formData </div> |
| 5e1c08eb C |
6353 | </div> |
| 6354 | <div class="prop-value"> | |
| 2963c343 | 6355 | <p>The file to upload.</p> |
| 5e1c08eb C |
6356 | </div> |
| 6357 | </div> | |
| 5e1c08eb C |
6358 | </section> |
| 6359 | </div> | |
| 6360 | <div class="doc-examples"></div> | |
| 6361 | </div> | |
| 6362 | <div class="doc-row"> | |
| 6363 | <div class="doc-copy"> | |
| 6364 | <section class="swagger-responses"> | |
| 6365 | <div class="prop-row prop-group"> | |
| 6366 | <div class="prop-name"> | |
| 6367 | <div class="prop-title">200 OK</div> | |
| ab0ee6a1 C |
6368 | <div class="prop-ref"> |
| 6369 | <span class=""> | |
| 2963c343 | 6370 | <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a> |
| ab0ee6a1 C |
6371 | </span> |
| 6372 | </div> | |
| 6373 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 5e1c08eb C |
6374 | </div> |
| 6375 | <div class="prop-value"> | |
| 6376 | <p>successful operation</p> | |
| 6377 | </div> | |
| 6378 | </div> | |
| 6379 | </section> | |
| 6380 | </div> | |
| 6381 | <div class="doc-examples"> | |
| 6382 | <h5>Response Content-Types: | |
| 6383 | <span>application/json</span> | |
| 6384 | </h5> | |
| ab0ee6a1 C |
6385 | <section> |
| 6386 | <h5>Response Example | |
| 6387 | <span>(200 OK)</span> | |
| 6388 | </h5> | |
| 6389 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 2963c343 RK |
6390 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, |
| 6391 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 6392 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| ab0ee6a1 C |
6393 | } |
| 6394 | </code></pre> | |
| 6395 | <!-- </div> --> | |
| 6396 | </section> | |
| 5e1c08eb C |
6397 | </div> |
| 6398 | </div> | |
| 94ff4c23 C |
6399 | <div class="doc-row"> |
| 6400 | <div class="doc-copy"> | |
| 6401 | <section class="swagger-request-security"> | |
| 6402 | <table class="table"> | |
| 6403 | <thead> | |
| 6404 | <tr> | |
| 6405 | <th class="swagger-request-security-schema"></th> | |
| 6406 | <th class="swagger-request-security-scopes"></th> | |
| 6407 | </tr> | |
| 6408 | </thead> | |
| 6409 | <tbody> | |
| 6410 | <tr> | |
| 6411 | <td> | |
| 6412 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 6413 | </td> | |
| 6414 | <td> </td> | |
| 6415 | </tr> | |
| 6416 | </tbody> | |
| 6417 | </table> | |
| 6418 | </section> | |
| 6419 | </div> | |
| 6420 | </div> | |
| 5e1c08eb | 6421 | </div> |
| 2963c343 RK |
6422 | <h1 id="tag-VideoBlacklist" class="swagger-summary-tag" data-traverse-target="tag-VideoBlacklist">VideoBlacklist</h1> |
| 6423 | <div id="operation--videos--id--blacklist-post" class="operation panel" data-traverse-target="operation--videos--id--blacklist-post"> | |
| 5e1c08eb C |
6424 | <!-- <section class="operation-tags row"> --> |
| 6425 | <!-- <div class="doc-copy"> --> | |
| 6426 | <div class="operation-tags"> | |
| 2963c343 | 6427 | <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> |
| 5e1c08eb C |
6428 | <!----> |
| 6429 | </div> | |
| 6430 | <!-- </div> --> | |
| 6431 | <!-- </section> --> | |
| 6432 | <h2 class="operation-title"> | |
| 2963c343 | 6433 | <span class="operation-summary">Put on blacklist a video by its id</span> |
| 5e1c08eb | 6434 | </h2> |
| 2963c343 RK |
6435 | <div class="doc-row"> |
| 6436 | <div class="doc-copy"> | |
| 6437 | <section class="swagger-operation-path"> | |
| 6438 | <span class="operation-method">POST</span> | |
| 6439 | <span class="operation-path">/videos/{id}/blacklist</span> | |
| 6440 | </section> | |
| 6441 | </div> | |
| 6442 | </div> | |
| 5e1c08eb C |
6443 | <div class="doc-row"> |
| 6444 | <div class="doc-copy"> | |
| 6445 | <section class="swagger-request-params"> | |
| 6446 | <div class="prop-row prop-group"> | |
| 6447 | <div class="prop-name"> | |
| 330eaf12 C |
6448 | <div class="prop-title">id: |
| 6449 | <span class="prop-type"> | |
| 6450 | <span class="json-property-type">string</span> | |
| 6451 | <span class="json-property-range" title="Value limits"></span> | |
| 6452 | </span> | |
| 6453 | </div> | |
| 5e1c08eb | 6454 | <span class="json-property-required"></span> |
| 228e84aa | 6455 | <div class="prop-subtitle"> in path </div> |
| 5e1c08eb C |
6456 | </div> |
| 6457 | <div class="prop-value"> | |
| 330eaf12 | 6458 | <p>The video id or uuid</p> |
| 5e1c08eb C |
6459 | </div> |
| 6460 | </div> | |
| 5e1c08eb C |
6461 | </section> |
| 6462 | </div> | |
| 6463 | <div class="doc-examples"></div> | |
| 6464 | </div> | |
| 6465 | <div class="doc-row"> | |
| 6466 | <div class="doc-copy"> | |
| 6467 | <section class="swagger-responses"> | |
| 6468 | <div class="prop-row prop-group"> | |
| 6469 | <div class="prop-name"> | |
| 6470 | <div class="prop-title">204 No Content</div> | |
| 6471 | </div> | |
| 6472 | <div class="prop-value"> | |
| 330eaf12 | 6473 | <p>Successful operation</p> |
| 5e1c08eb C |
6474 | </div> |
| 6475 | </div> | |
| 6476 | </section> | |
| 6477 | </div> | |
| 6478 | <div class="doc-examples"> | |
| 6479 | <h5>Response Content-Types: | |
| 6480 | <span>application/json</span> | |
| 6481 | </h5> | |
| 6482 | </div> | |
| 6483 | </div> | |
| 94ff4c23 C |
6484 | <div class="doc-row"> |
| 6485 | <div class="doc-copy"> | |
| 6486 | <section class="swagger-request-security"> | |
| 6487 | <table class="table"> | |
| 6488 | <thead> | |
| 6489 | <tr> | |
| 6490 | <th class="swagger-request-security-schema"></th> | |
| 6491 | <th class="swagger-request-security-scopes"></th> | |
| 6492 | </tr> | |
| 6493 | </thead> | |
| 6494 | <tbody> | |
| 6495 | <tr> | |
| 6496 | <td> | |
| 6497 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 6498 | </td> | |
| 2963c343 RK |
6499 | <td> |
| 6500 | <a href="#security-definition-scope-admin">admin</a>, | |
| 6501 | <a href="#security-definition-scope-moderator">moderator</a> | |
| 6502 | </td> | |
| 94ff4c23 C |
6503 | </tr> |
| 6504 | </tbody> | |
| 6505 | </table> | |
| 6506 | </section> | |
| 6507 | </div> | |
| 6508 | </div> | |
| 5e1c08eb | 6509 | </div> |
| 2963c343 | 6510 | <div id="operation--videos--id--blacklist-delete" class="operation panel" data-traverse-target="operation--videos--id--blacklist-delete"> |
| 5e1c08eb C |
6511 | <!-- <section class="operation-tags row"> --> |
| 6512 | <!-- <div class="doc-copy"> --> | |
| 6513 | <div class="operation-tags"> | |
| 2963c343 | 6514 | <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> |
| 5e1c08eb C |
6515 | <!----> |
| 6516 | </div> | |
| 6517 | <!-- </div> --> | |
| 6518 | <!-- </section> --> | |
| 6519 | <h2 class="operation-title"> | |
| 2963c343 | 6520 | <span class="operation-summary">Delete an entry of the blacklist of a video by its id</span> |
| 5e1c08eb | 6521 | </h2> |
| 2963c343 RK |
6522 | <div class="doc-row"> |
| 6523 | <div class="doc-copy"> | |
| 6524 | <section class="swagger-operation-path"> | |
| 6525 | <span class="operation-method">DELETE</span> | |
| 6526 | <span class="operation-path">/videos/{id}/blacklist</span> | |
| 6527 | </section> | |
| 6528 | </div> | |
| 6529 | </div> | |
| 5e1c08eb C |
6530 | <div class="doc-row"> |
| 6531 | <div class="doc-copy"> | |
| 6532 | <section class="swagger-request-params"> | |
| 6533 | <div class="prop-row prop-group"> | |
| 6534 | <div class="prop-name"> | |
| 330eaf12 C |
6535 | <div class="prop-title">id: |
| 6536 | <span class="prop-type"> | |
| 6537 | <span class="json-property-type">string</span> | |
| 6538 | <span class="json-property-range" title="Value limits"></span> | |
| 6539 | </span> | |
| 6540 | </div> | |
| 5e1c08eb | 6541 | <span class="json-property-required"></span> |
| 228e84aa | 6542 | <div class="prop-subtitle"> in path </div> |
| 5e1c08eb C |
6543 | </div> |
| 6544 | <div class="prop-value"> | |
| 330eaf12 | 6545 | <p>The video id or uuid</p> |
| 5e1c08eb C |
6546 | </div> |
| 6547 | </div> | |
| 5e1c08eb C |
6548 | </section> |
| 6549 | </div> | |
| 6550 | <div class="doc-examples"></div> | |
| 6551 | </div> | |
| 6552 | <div class="doc-row"> | |
| 6553 | <div class="doc-copy"> | |
| 6554 | <section class="swagger-responses"> | |
| 6555 | <div class="prop-row prop-group"> | |
| 6556 | <div class="prop-name"> | |
| 6557 | <div class="prop-title">204 No Content</div> | |
| 6558 | </div> | |
| 6559 | <div class="prop-value"> | |
| 330eaf12 | 6560 | <p>Successful operation</p> |
| 5e1c08eb C |
6561 | </div> |
| 6562 | </div> | |
| 6563 | </section> | |
| 6564 | </div> | |
| 6565 | <div class="doc-examples"> | |
| 6566 | <h5>Response Content-Types: | |
| 6567 | <span>application/json</span> | |
| 6568 | </h5> | |
| 6569 | </div> | |
| 6570 | </div> | |
| 94ff4c23 C |
6571 | <div class="doc-row"> |
| 6572 | <div class="doc-copy"> | |
| 6573 | <section class="swagger-request-security"> | |
| 6574 | <table class="table"> | |
| 6575 | <thead> | |
| 6576 | <tr> | |
| 6577 | <th class="swagger-request-security-schema"></th> | |
| 6578 | <th class="swagger-request-security-scopes"></th> | |
| 6579 | </tr> | |
| 6580 | </thead> | |
| 6581 | <tbody> | |
| 6582 | <tr> | |
| 6583 | <td> | |
| 6584 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 6585 | </td> | |
| 2963c343 RK |
6586 | <td> |
| 6587 | <a href="#security-definition-scope-admin">admin</a>, | |
| 6588 | <a href="#security-definition-scope-moderator">moderator</a> | |
| 6589 | </td> | |
| 94ff4c23 C |
6590 | </tr> |
| 6591 | </tbody> | |
| 6592 | </table> | |
| 6593 | </section> | |
| 6594 | </div> | |
| 6595 | </div> | |
| fb72c193 | 6596 | </div> |
| 2963c343 | 6597 | <div id="operation--videos-blacklist-get" class="operation panel" data-traverse-target="operation--videos-blacklist-get"> |
| fb72c193 DL |
6598 | <!-- <section class="operation-tags row"> --> |
| 6599 | <!-- <div class="doc-copy"> --> | |
| 6600 | <div class="operation-tags"> | |
| 2963c343 | 6601 | <a class="label" href="#tag-VideoBlacklist">VideoBlacklist</a> |
| fb72c193 DL |
6602 | <!----> |
| 6603 | </div> | |
| 6604 | <!-- </div> --> | |
| 6605 | <!-- </section> --> | |
| 6606 | <h2 class="operation-title"> | |
| 2963c343 | 6607 | <span class="operation-summary">Get list of videos on blacklist</span> |
| fb72c193 | 6608 | </h2> |
| 2963c343 RK |
6609 | <div class="doc-row"> |
| 6610 | <div class="doc-copy"> | |
| 6611 | <section class="swagger-operation-path"> | |
| 6612 | <span class="operation-method">GET</span> | |
| 6613 | <span class="operation-path">/videos/blacklist</span> | |
| 6614 | </section> | |
| 6615 | </div> | |
| 6616 | </div> | |
| fb72c193 DL |
6617 | <div class="doc-row"> |
| 6618 | <div class="doc-copy"> | |
| 6619 | <section class="swagger-request-params"> | |
| 6620 | <div class="prop-row prop-group"> | |
| 6621 | <div class="prop-name"> | |
| 6622 | <div class="prop-title">start: | |
| 6623 | <span class="prop-type"> | |
| 6624 | <span class="json-property-type">number</span> | |
| 6625 | <span class="json-property-range" title="Value limits"></span> | |
| 6626 | </span> | |
| 6627 | </div> | |
| 6628 | <div class="prop-subtitle"> in query </div> | |
| 6629 | </div> | |
| 6630 | <div class="prop-value"> | |
| 6631 | <p>Offset</p> | |
| 6632 | </div> | |
| 6633 | </div> | |
| 6634 | <div class="prop-row prop-group"> | |
| 6635 | <div class="prop-name"> | |
| 6636 | <div class="prop-title">count: | |
| 6637 | <span class="prop-type"> | |
| 6638 | <span class="json-property-type">number</span> | |
| 6639 | <span class="json-property-range" title="Value limits"></span> | |
| 6640 | </span> | |
| 6641 | </div> | |
| 6642 | <div class="prop-subtitle"> in query </div> | |
| 6643 | </div> | |
| 6644 | <div class="prop-value"> | |
| 6645 | <p>Number of items</p> | |
| 6646 | </div> | |
| 6647 | </div> | |
| 6648 | <div class="prop-row prop-group"> | |
| 6649 | <div class="prop-name"> | |
| 6650 | <div class="prop-title">sort: | |
| 6651 | <span class="prop-type"> | |
| 6652 | <span class="json-property-type">string</span> | |
| 6653 | <span class="json-property-range" title="Value limits"></span> | |
| 6654 | </span> | |
| 6655 | </div> | |
| 6656 | <div class="prop-subtitle"> in query </div> | |
| 6657 | </div> | |
| 6658 | <div class="prop-value"> | |
| 6659 | <p>Sort column (-createdAt for example)</p> | |
| 6660 | </div> | |
| 6661 | </div> | |
| fb72c193 DL |
6662 | </section> |
| 6663 | </div> | |
| 6664 | <div class="doc-examples"></div> | |
| 6665 | </div> | |
| 6666 | <div class="doc-row"> | |
| 6667 | <div class="doc-copy"> | |
| 6668 | <section class="swagger-responses"> | |
| 6669 | <div class="prop-row prop-group"> | |
| 6670 | <div class="prop-name"> | |
| 6671 | <div class="prop-title">200 OK</div> | |
| 6672 | <div class="prop-ref"> | |
| 6673 | <span class="json-schema-ref-array"> | |
| 2963c343 | 6674 | <a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a> |
| fb72c193 DL |
6675 | </span> |
| 6676 | </div> | |
| 6677 | <!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> --> | |
| 6678 | </div> | |
| 6679 | <div class="prop-value"> | |
| 6680 | <p>successful operation</p> | |
| 6681 | </div> | |
| 6682 | </div> | |
| 6683 | <div class="prop-row prop-inner"> | |
| 6684 | <div class="prop-name">type</div> | |
| 6685 | <div class="prop-value"> | |
| 6686 | <span class="json-property-type"> | |
| 6687 | <span class="json-schema-ref-array"> | |
| 2963c343 | 6688 | <a class="json-schema-ref" href="#/definitions/VideoBlacklist">VideoBlacklist</a> |
| fb72c193 DL |
6689 | </span> |
| 6690 | </span> | |
| 6691 | <span class="json-property-range" title="Value limits"></span> | |
| 6692 | </div> | |
| 6693 | </div> | |
| 6694 | </section> | |
| 6695 | </div> | |
| 6696 | <div class="doc-examples"> | |
| 6697 | <h5>Response Content-Types: | |
| 6698 | <span>application/json</span> | |
| 6699 | </h5> | |
| 6700 | <section> | |
| 6701 | <h5>Response Example | |
| 6702 | <span>(200 OK)</span> | |
| 6703 | </h5> | |
| 6704 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">[ | |
| 6705 | { | |
| 6706 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 2963c343 | 6707 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, |
| fb72c193 | 6708 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
| fb72c193 | 6709 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, |
| 2963c343 RK |
6710 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, |
| 6711 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| fb72c193 DL |
6712 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
| 6713 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| fb72c193 DL |
6714 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, |
| 6715 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 6716 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 2963c343 | 6717 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> |
| fb72c193 DL |
6718 | } |
| 6719 | ] | |
| 6720 | </code></pre> | |
| 6721 | <!-- </div> --> | |
| 6722 | </section> | |
| 6723 | </div> | |
| 6724 | </div> | |
| 2963c343 RK |
6725 | <div class="doc-row"> |
| 6726 | <div class="doc-copy"> | |
| 6727 | <section class="swagger-request-security"> | |
| 6728 | <table class="table"> | |
| 6729 | <thead> | |
| 6730 | <tr> | |
| 6731 | <th class="swagger-request-security-schema"></th> | |
| 6732 | <th class="swagger-request-security-scopes"></th> | |
| 6733 | </tr> | |
| 6734 | </thead> | |
| 6735 | <tbody> | |
| 6736 | <tr> | |
| 6737 | <td> | |
| 6738 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 6739 | </td> | |
| 6740 | <td> | |
| 6741 | <a href="#security-definition-scope-admin">admin</a>, | |
| 6742 | <a href="#security-definition-scope-moderator">moderator</a> | |
| 6743 | </td> | |
| 6744 | </tr> | |
| 6745 | </tbody> | |
| 6746 | </table> | |
| 6747 | </section> | |
| 6748 | </div> | |
| 6749 | </div> | |
| 6750 | </div> | |
| 6751 | <h1 id="tag-VideoRate" class="swagger-summary-tag" data-traverse-target="tag-VideoRate">VideoRate</h1> | |
| 6752 | <div id="operation--videos--id--rate-put" class="operation panel" data-traverse-target="operation--videos--id--rate-put"> | |
| 6753 | <!-- <section class="operation-tags row"> --> | |
| 6754 | <!-- <div class="doc-copy"> --> | |
| 6755 | <div class="operation-tags"> | |
| 6756 | <a class="label" href="#tag-VideoRate">VideoRate</a> | |
| 6757 | <!----> | |
| 6758 | </div> | |
| 6759 | <!-- </div> --> | |
| 6760 | <!-- </section> --> | |
| 6761 | <h2 class="operation-title"> | |
| 6762 | <span class="operation-summary">Vote for a video by its id</span> | |
| 6763 | </h2> | |
| 6764 | <div class="doc-row"> | |
| 6765 | <div class="doc-copy"> | |
| 6766 | <section class="swagger-operation-path"> | |
| 6767 | <span class="operation-method">PUT</span> | |
| 6768 | <span class="operation-path">/videos/{id}/rate</span> | |
| 6769 | </section> | |
| 6770 | </div> | |
| 6771 | </div> | |
| 6772 | <div class="doc-row"> | |
| 6773 | <div class="doc-copy"> | |
| 6774 | <section class="swagger-request-params"> | |
| 6775 | <div class="prop-row prop-group"> | |
| 6776 | <div class="prop-name"> | |
| 6777 | <div class="prop-title">id: | |
| 6778 | <span class="prop-type"> | |
| 6779 | <span class="json-property-type">string</span> | |
| 6780 | <span class="json-property-range" title="Value limits"></span> | |
| 6781 | </span> | |
| 6782 | </div> | |
| 6783 | <span class="json-property-required"></span> | |
| 6784 | <div class="prop-subtitle"> in path </div> | |
| 6785 | </div> | |
| 6786 | <div class="prop-value"> | |
| 6787 | <p>The video id or uuid</p> | |
| 6788 | </div> | |
| 6789 | </div> | |
| 6790 | </section> | |
| 6791 | </div> | |
| 6792 | <div class="doc-examples"></div> | |
| 6793 | </div> | |
| 6794 | <div class="doc-row"> | |
| 6795 | <div class="doc-copy"> | |
| 6796 | <section class="swagger-responses"> | |
| 6797 | <div class="prop-row prop-group"> | |
| 6798 | <div class="prop-name"> | |
| 6799 | <div class="prop-title">204 No Content</div> | |
| 6800 | </div> | |
| 6801 | <div class="prop-value"> | |
| 6802 | <p>Successful operation</p> | |
| 6803 | </div> | |
| 6804 | </div> | |
| 6805 | </section> | |
| 6806 | </div> | |
| 6807 | <div class="doc-examples"> | |
| 6808 | <h5>Response Content-Types: | |
| 6809 | <span>application/json</span> | |
| 6810 | </h5> | |
| 6811 | </div> | |
| 6812 | </div> | |
| 6813 | <div class="doc-row"> | |
| 6814 | <div class="doc-copy"> | |
| 6815 | <section class="swagger-request-security"> | |
| 6816 | <table class="table"> | |
| 6817 | <thead> | |
| 6818 | <tr> | |
| 6819 | <th class="swagger-request-security-schema"></th> | |
| 6820 | <th class="swagger-request-security-scopes"></th> | |
| 6821 | </tr> | |
| 6822 | </thead> | |
| 6823 | <tbody> | |
| 6824 | <tr> | |
| 6825 | <td> | |
| 6826 | <a href="#security-definition-OAuth2">OAuth2</a> | |
| 6827 | </td> | |
| 6828 | <td> </td> | |
| 6829 | </tr> | |
| 6830 | </tbody> | |
| 6831 | </table> | |
| 6832 | </section> | |
| 6833 | </div> | |
| 6834 | </div> | |
| 5e1c08eb C |
6835 | </div> |
| 6836 | <h1>Schema Definitions</h1> | |
| 48dce1c9 | 6837 | <div id="definition-VideoConstantNumber" class="definition panel" data-traverse-target="definition-VideoConstantNumber"> |
| 5d00a3d7 | 6838 | <h2 class="panel-title"> |
| 48dce1c9 | 6839 | <a name="/definitions/VideoConstantNumber"></a>VideoConstantNumber: |
| 2963c343 | 6840 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5d00a3d7 C |
6841 | <span class="json-property-range" title="Value limits"></span> |
| 6842 | ||
| 6843 | ||
| 6844 | </span> --> | |
| 6845 | </h2> | |
| 6846 | <div class="doc-row"> | |
| 6847 | <div class="doc-copy"> | |
| 6848 | <section class="json-schema-properties"> | |
| 6849 | <dl> | |
| 6850 | <dt data-property-name="id"> | |
| 6851 | <span class="json-property-name">id:</span> | |
| 6852 | <span class="json-property-type">number</span> | |
| 6853 | <span class="json-property-range" title="Value limits"></span> | |
| 6854 | </dt> | |
| 6855 | <dt data-property-name="label"> | |
| 6856 | <span class="json-property-name">label:</span> | |
| 6857 | <span class="json-property-type">string</span> | |
| 6858 | <span class="json-property-range" title="Value limits"></span> | |
| 6859 | </dt> | |
| 6860 | </dl> | |
| 6861 | </section> | |
| 6862 | </div> | |
| 6863 | <div class="doc-examples"> | |
| 6864 | <section> | |
| 6865 | <h5>Example</h5> | |
| 6866 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 6867 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 6868 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 6869 | } | |
| 48dce1c9 C |
6870 | </code></pre> |
| 6871 | <!-- </div> --> | |
| 6872 | </section> | |
| 6873 | </div> | |
| 6874 | </div> | |
| 6875 | </div> | |
| 6876 | <div id="definition-VideoConstantString" class="definition panel" data-traverse-target="definition-VideoConstantString"> | |
| 6877 | <h2 class="panel-title"> | |
| 6878 | <a name="/definitions/VideoConstantString"></a>VideoConstantString: | |
| 2963c343 | 6879 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 48dce1c9 C |
6880 | <span class="json-property-range" title="Value limits"></span> |
| 6881 | ||
| 6882 | ||
| 6883 | </span> --> | |
| 6884 | </h2> | |
| 6885 | <div class="doc-row"> | |
| 6886 | <div class="doc-copy"> | |
| 6887 | <section class="json-schema-properties"> | |
| 6888 | <dl> | |
| 6889 | <dt data-property-name="id"> | |
| 6890 | <span class="json-property-name">id:</span> | |
| 6891 | <span class="json-property-type">string</span> | |
| 6892 | <span class="json-property-range" title="Value limits"></span> | |
| 6893 | </dt> | |
| 6894 | <dt data-property-name="label"> | |
| 6895 | <span class="json-property-name">label:</span> | |
| 6896 | <span class="json-property-type">string</span> | |
| 6897 | <span class="json-property-range" title="Value limits"></span> | |
| 6898 | </dt> | |
| 6899 | </dl> | |
| 6900 | </section> | |
| 6901 | </div> | |
| 6902 | <div class="doc-examples"> | |
| 6903 | <section> | |
| 6904 | <h5>Example</h5> | |
| 6905 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 6906 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
| 6907 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 6908 | } | |
| 5d00a3d7 C |
6909 | </code></pre> |
| 6910 | <!-- </div> --> | |
| 6911 | </section> | |
| 6912 | </div> | |
| 6913 | </div> | |
| 6914 | </div> | |
| 61b66b36 C |
6915 | <div id="definition-VideoPrivacy" class="definition panel" data-traverse-target="definition-VideoPrivacy"> |
| 6916 | <h2 class="panel-title"> | |
| 6917 | <a name="/definitions/VideoPrivacy"></a>VideoPrivacy: string | |
| 2963c343 | 6918 | <!-- <span class="json-property-type"><span class="json-property-type">string</span> <span class="json-property-enum" title="Possible values"> |
| 61b66b36 C |
6919 | <span class="json-property-enum-item">Public</span>, |
| 6920 | <span class="json-property-enum-item">Unlisted</span>, | |
| 6921 | <span class="json-property-enum-item">Private</span> | |
| 6922 | </span> | |
| 6923 | <span class="json-property-range" title="Value limits"></span> | |
| 6924 | ||
| 6925 | ||
| 6926 | </span> --> | |
| 6927 | </h2> | |
| 6928 | <div class="doc-row"> | |
| 6929 | <div class="doc-copy"> | |
| 6930 | <span class="json-property-type">string</span> | |
| 6931 | <span class="json-property-enum" title="Possible values"> | |
| 6932 | <span class="json-property-enum-item">Public</span>, | |
| 6933 | <span class="json-property-enum-item">Unlisted</span>, | |
| 6934 | <span class="json-property-enum-item">Private</span> | |
| 6935 | </span> | |
| 6936 | <span class="json-property-range" title="Value limits"></span> | |
| 6937 | </div> | |
| 6938 | </div> | |
| 6939 | </div> | |
| 5e1c08eb C |
6940 | <div id="definition-Video" class="definition panel" data-traverse-target="definition-Video"> |
| 6941 | <h2 class="panel-title"> | |
| 6942 | <a name="/definitions/Video"></a>Video: | |
| 2963c343 | 6943 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
6944 | <span class="json-property-range" title="Value limits"></span> |
| 6945 | ||
| 6946 | ||
| 6947 | </span> --> | |
| 6948 | </h2> | |
| 6949 | <div class="doc-row"> | |
| 6950 | <div class="doc-copy"> | |
| 6951 | <section class="json-schema-properties"> | |
| 6952 | <dl> | |
| 6953 | <dt data-property-name="id"> | |
| 6954 | <span class="json-property-name">id:</span> | |
| 6955 | <span class="json-property-type">number</span> | |
| 6956 | <span class="json-property-range" title="Value limits"></span> | |
| 6957 | </dt> | |
| 6958 | <dt data-property-name="uuid"> | |
| 6959 | <span class="json-property-name">uuid:</span> | |
| 6960 | <span class="json-property-type">string</span> | |
| 6961 | <span class="json-property-range" title="Value limits"></span> | |
| 6962 | </dt> | |
| 5e1c08eb C |
6963 | <dt data-property-name="createdAt"> |
| 6964 | <span class="json-property-name">createdAt:</span> | |
| 6965 | <span class="json-property-type">string</span> | |
| 6966 | <span class="json-property-range" title="Value limits"></span> | |
| 6967 | </dt> | |
| 61b66b36 C |
6968 | <dt data-property-name="publishedAt"> |
| 6969 | <span class="json-property-name">publishedAt:</span> | |
| 6970 | <span class="json-property-type">string</span> | |
| 6971 | <span class="json-property-range" title="Value limits"></span> | |
| 6972 | </dt> | |
| 5e1c08eb C |
6973 | <dt data-property-name="updatedAt"> |
| 6974 | <span class="json-property-name">updatedAt:</span> | |
| 6975 | <span class="json-property-type">string</span> | |
| 6976 | <span class="json-property-range" title="Value limits"></span> | |
| 6977 | </dt> | |
| 5e1c08eb C |
6978 | <dt data-property-name="category"> |
| 6979 | <span class="json-property-name">category:</span> | |
| 5d00a3d7 C |
6980 | <span class="json-property-type"> |
| 6981 | <span class=""> | |
| 48dce1c9 | 6982 | <a class="json-schema-ref" href="#/definitions/VideoConstantNumber">VideoConstantNumber</a> |
| 5d00a3d7 C |
6983 | </span> |
| 6984 | </span> | |
| 5e1c08eb C |
6985 | <span class="json-property-range" title="Value limits"></span> |
| 6986 | </dt> | |
| 6987 | <dt data-property-name="licence"> | |
| 6988 | <span class="json-property-name">licence:</span> | |
| 5d00a3d7 C |
6989 | <span class="json-property-type"> |
| 6990 | <span class=""> | |
| 48dce1c9 | 6991 | <a class="json-schema-ref" href="#/definitions/VideoConstantNumber">VideoConstantNumber</a> |
| 5d00a3d7 C |
6992 | </span> |
| 6993 | </span> | |
| 5e1c08eb C |
6994 | <span class="json-property-range" title="Value limits"></span> |
| 6995 | </dt> | |
| 6996 | <dt data-property-name="language"> | |
| 6997 | <span class="json-property-name">language:</span> | |
| 5d00a3d7 C |
6998 | <span class="json-property-type"> |
| 6999 | <span class=""> | |
| 48dce1c9 | 7000 | <a class="json-schema-ref" href="#/definitions/VideoConstantString">VideoConstantString</a> |
| 5d00a3d7 C |
7001 | </span> |
| 7002 | </span> | |
| 5e1c08eb C |
7003 | <span class="json-property-range" title="Value limits"></span> |
| 7004 | </dt> | |
| 61b66b36 C |
7005 | <dt data-property-name="privacy"> |
| 7006 | <span class="json-property-name">privacy:</span> | |
| 7007 | <span class="json-property-type"> | |
| 7008 | <span class=""> | |
| 7009 | <a class="json-schema-ref" href="#/definitions/VideoPrivacy">VideoPrivacy</a> | |
| 7010 | </span> | |
| 7011 | </span> | |
| 7012 | <span class="json-property-range" title="Value limits"></span> | |
| 7013 | </dt> | |
| 5e1c08eb C |
7014 | <dt data-property-name="description"> |
| 7015 | <span class="json-property-name">description:</span> | |
| 7016 | <span class="json-property-type">string</span> | |
| 7017 | <span class="json-property-range" title="Value limits"></span> | |
| 7018 | </dt> | |
| 7019 | <dt data-property-name="duration"> | |
| 7020 | <span class="json-property-name">duration:</span> | |
| 7021 | <span class="json-property-type">number</span> | |
| 7022 | <span class="json-property-range" title="Value limits"></span> | |
| 7023 | </dt> | |
| 7024 | <dt data-property-name="isLocal"> | |
| 7025 | <span class="json-property-name">isLocal:</span> | |
| 7026 | <span class="json-property-type">boolean</span> | |
| 7027 | <span class="json-property-range" title="Value limits"></span> | |
| 7028 | </dt> | |
| 7029 | <dt data-property-name="name"> | |
| 7030 | <span class="json-property-name">name:</span> | |
| 7031 | <span class="json-property-type">string</span> | |
| 7032 | <span class="json-property-range" title="Value limits"></span> | |
| 7033 | </dt> | |
| 5e1c08eb C |
7034 | <dt data-property-name="thumbnailPath"> |
| 7035 | <span class="json-property-name">thumbnailPath:</span> | |
| 7036 | <span class="json-property-type">string</span> | |
| 7037 | <span class="json-property-range" title="Value limits"></span> | |
| 7038 | </dt> | |
| 7039 | <dt data-property-name="previewPath"> | |
| 7040 | <span class="json-property-name">previewPath:</span> | |
| 7041 | <span class="json-property-type">string</span> | |
| 7042 | <span class="json-property-range" title="Value limits"></span> | |
| 7043 | </dt> | |
| 7044 | <dt data-property-name="embedPath"> | |
| 7045 | <span class="json-property-name">embedPath:</span> | |
| 7046 | <span class="json-property-type">string</span> | |
| 7047 | <span class="json-property-range" title="Value limits"></span> | |
| 7048 | </dt> | |
| 7049 | <dt data-property-name="views"> | |
| 7050 | <span class="json-property-name">views:</span> | |
| 7051 | <span class="json-property-type">number</span> | |
| 7052 | <span class="json-property-range" title="Value limits"></span> | |
| 7053 | </dt> | |
| 7054 | <dt data-property-name="likes"> | |
| 7055 | <span class="json-property-name">likes:</span> | |
| 7056 | <span class="json-property-type">number</span> | |
| 7057 | <span class="json-property-range" title="Value limits"></span> | |
| 7058 | </dt> | |
| 7059 | <dt data-property-name="dislikes"> | |
| 7060 | <span class="json-property-name">dislikes:</span> | |
| 7061 | <span class="json-property-type">number</span> | |
| 7062 | <span class="json-property-range" title="Value limits"></span> | |
| 7063 | </dt> | |
| 7064 | <dt data-property-name="nsfw"> | |
| 7065 | <span class="json-property-name">nsfw:</span> | |
| 7066 | <span class="json-property-type">boolean</span> | |
| 7067 | <span class="json-property-range" title="Value limits"></span> | |
| 7068 | </dt> | |
| 5d00a3d7 C |
7069 | <dt data-property-name="account"> |
| 7070 | <span class="json-property-name">account:</span> | |
| 7071 | <span class="json-property-type">object</span> | |
| 7072 | <span class="json-property-range" title="Value limits"></span> | |
| 7073 | </dt> | |
| ad9e39fb C |
7074 | <dt class="json-inner-schema"> |
| 7075 | <section class="json-schema-properties"> | |
| 7076 | <dl> | |
| 7077 | <dt data-property-name="name"> | |
| 7078 | <span class="json-property-name">name:</span> | |
| 7079 | <span class="json-property-type">string</span> | |
| 7080 | <span class="json-property-range" title="Value limits"></span> | |
| 7081 | </dt> | |
| 7082 | <dt data-property-name="displayName"> | |
| 7083 | <span class="json-property-name">displayName:</span> | |
| 7084 | <span class="json-property-type">string</span> | |
| 7085 | <span class="json-property-range" title="Value limits"></span> | |
| 7086 | </dt> | |
| 7087 | <dt data-property-name="url"> | |
| 7088 | <span class="json-property-name">url:</span> | |
| 7089 | <span class="json-property-type">string</span> | |
| 7090 | <span class="json-property-range" title="Value limits"></span> | |
| 7091 | </dt> | |
| 7092 | <dt data-property-name="host"> | |
| 7093 | <span class="json-property-name">host:</span> | |
| 7094 | <span class="json-property-type">string</span> | |
| 7095 | <span class="json-property-range" title="Value limits"></span> | |
| 7096 | </dt> | |
| 7097 | <dt data-property-name="avatar"> | |
| 7098 | <span class="json-property-name">avatar:</span> | |
| 7099 | <span class="json-property-type"> | |
| 7100 | <span class=""> | |
| 7101 | <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a> | |
| 7102 | </span> | |
| 7103 | </span> | |
| 7104 | <span class="json-property-range" title="Value limits"></span> | |
| 7105 | </dt> | |
| 7106 | </dl> | |
| 7107 | </section> | |
| 7108 | </dt> | |
| 5e1c08eb C |
7109 | </dl> |
| 7110 | </section> | |
| 7111 | </div> | |
| 7112 | <div class="doc-examples"> | |
| 7113 | <section> | |
| 7114 | <h5>Example</h5> | |
| 7115 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7116 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7117 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 5e1c08eb | 7118 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, |
| 61b66b36 | 7119 | <span class="hljs-attr">"publishedAt"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb | 7120 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, |
| 5d00a3d7 C |
7121 | <span class="hljs-attr">"category"</span>: { |
| 7122 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7123 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 7124 | }, | |
| 7125 | <span class="hljs-attr">"licence"</span>: { | |
| 7126 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7127 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> | |
| 7128 | }, | |
| 7129 | <span class="hljs-attr">"language"</span>: { | |
| 48dce1c9 | 7130 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, |
| 5d00a3d7 C |
7131 | <span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span> |
| 7132 | }, | |
| 61b66b36 | 7133 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span>, |
| 5e1c08eb C |
7134 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, |
| 7135 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 7136 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| 7137 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 5e1c08eb C |
7138 | <span class="hljs-attr">"thumbnailPath"</span>: <span class="hljs-string">"string"</span>, |
| 7139 | <span class="hljs-attr">"previewPath"</span>: <span class="hljs-string">"string"</span>, | |
| 7140 | <span class="hljs-attr">"embedPath"</span>: <span class="hljs-string">"string"</span>, | |
| 7141 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 7142 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 7143 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 61b66b36 C |
7144 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span>, |
| 7145 | <span class="hljs-attr">"account"</span>: { | |
| 7146 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 7147 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 7148 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7149 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 7150 | <span class="hljs-attr">"avatar"</span>: { | |
| 7151 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 7152 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7153 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7154 | } | |
| 7155 | } | |
| 5e1c08eb C |
7156 | } |
| 7157 | </code></pre> | |
| 7158 | <!-- </div> --> | |
| 7159 | </section> | |
| 7160 | </div> | |
| 7161 | </div> | |
| 7162 | </div> | |
| 7163 | <div id="definition-VideoAbuse" class="definition panel" data-traverse-target="definition-VideoAbuse"> | |
| 7164 | <h2 class="panel-title"> | |
| 7165 | <a name="/definitions/VideoAbuse"></a>VideoAbuse: | |
| 2963c343 | 7166 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
7167 | <span class="json-property-range" title="Value limits"></span> |
| 7168 | ||
| 7169 | ||
| 7170 | </span> --> | |
| 7171 | </h2> | |
| 7172 | <div class="doc-row"> | |
| 7173 | <div class="doc-copy"> | |
| 7174 | <section class="json-schema-properties"> | |
| 7175 | <dl> | |
| 7176 | <dt data-property-name="id"> | |
| 7177 | <span class="json-property-name">id:</span> | |
| 7178 | <span class="json-property-type">number</span> | |
| 7179 | <span class="json-property-range" title="Value limits"></span> | |
| 7180 | </dt> | |
| 7181 | <dt data-property-name="reason"> | |
| 7182 | <span class="json-property-name">reason:</span> | |
| 7183 | <span class="json-property-type">string</span> | |
| 7184 | <span class="json-property-range" title="Value limits"></span> | |
| 7185 | </dt> | |
| 5d00a3d7 C |
7186 | <dt data-property-name="reporterAccount"> |
| 7187 | <span class="json-property-name">reporterAccount:</span> | |
| 7188 | <span class="json-property-type"> | |
| 7189 | <span class=""> | |
| 7190 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
| 7191 | </span> | |
| 7192 | </span> | |
| 5e1c08eb C |
7193 | <span class="json-property-range" title="Value limits"></span> |
| 7194 | </dt> | |
| 5d00a3d7 C |
7195 | <dt data-property-name="video"> |
| 7196 | <span class="json-property-name">video:</span> | |
| 7197 | <span class="json-property-type">object</span> | |
| 5e1c08eb C |
7198 | <span class="json-property-range" title="Value limits"></span> |
| 7199 | </dt> | |
| ad9e39fb C |
7200 | <dt class="json-inner-schema"> |
| 7201 | <section class="json-schema-properties"> | |
| 7202 | <dl> | |
| 7203 | <dt data-property-name="id"> | |
| 7204 | <span class="json-property-name">id:</span> | |
| 7205 | <span class="json-property-type">number</span> | |
| 7206 | <span class="json-property-range" title="Value limits"></span> | |
| 7207 | </dt> | |
| 7208 | <dt data-property-name="name"> | |
| 7209 | <span class="json-property-name">name:</span> | |
| 7210 | <span class="json-property-type">string</span> | |
| 7211 | <span class="json-property-range" title="Value limits"></span> | |
| 7212 | </dt> | |
| 7213 | <dt data-property-name="uuid"> | |
| 7214 | <span class="json-property-name">uuid:</span> | |
| 7215 | <span class="json-property-type">string</span> | |
| 7216 | <span class="json-property-range" title="Value limits"></span> | |
| 7217 | </dt> | |
| 7218 | <dt data-property-name="url"> | |
| 7219 | <span class="json-property-name">url:</span> | |
| 7220 | <span class="json-property-type">string</span> | |
| 7221 | <span class="json-property-range" title="Value limits"></span> | |
| 7222 | </dt> | |
| 7223 | </dl> | |
| 7224 | </section> | |
| 7225 | </dt> | |
| 5e1c08eb C |
7226 | <dt data-property-name="createdAt"> |
| 7227 | <span class="json-property-name">createdAt:</span> | |
| 7228 | <span class="json-property-type">string</span> | |
| 7229 | <span class="json-property-range" title="Value limits"></span> | |
| 7230 | </dt> | |
| 7231 | </dl> | |
| 7232 | </section> | |
| 7233 | </div> | |
| 7234 | <div class="doc-examples"> | |
| 7235 | <section> | |
| 7236 | <h5>Example</h5> | |
| 7237 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7238 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7239 | <span class="hljs-attr">"reason"</span>: <span class="hljs-string">"string"</span>, | |
| 5d00a3d7 C |
7240 | <span class="hljs-attr">"reporterAccount"</span>: { |
| 7241 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 7242 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7243 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 7244 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7245 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 7246 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 7247 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7248 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7249 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7250 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7251 | <span class="hljs-attr">"avatar"</span>: { | |
| 7252 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 7253 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7254 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7255 | } | |
| 7256 | }, | |
| 61b66b36 C |
7257 | <span class="hljs-attr">"video"</span>: { |
| 7258 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7259 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 7260 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 7261 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span> | |
| 7262 | }, | |
| 5e1c08eb C |
7263 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span> |
| 7264 | } | |
| 7265 | </code></pre> | |
| 7266 | <!-- </div> --> | |
| 7267 | </section> | |
| 7268 | </div> | |
| 7269 | </div> | |
| 7270 | </div> | |
| 7271 | <div id="definition-VideoBlacklist" class="definition panel" data-traverse-target="definition-VideoBlacklist"> | |
| 7272 | <h2 class="panel-title"> | |
| 7273 | <a name="/definitions/VideoBlacklist"></a>VideoBlacklist: | |
| 2963c343 | 7274 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
7275 | <span class="json-property-range" title="Value limits"></span> |
| 7276 | ||
| 7277 | ||
| 7278 | </span> --> | |
| 7279 | </h2> | |
| 7280 | <div class="doc-row"> | |
| 7281 | <div class="doc-copy"> | |
| 7282 | <section class="json-schema-properties"> | |
| 7283 | <dl> | |
| 7284 | <dt data-property-name="id"> | |
| 7285 | <span class="json-property-name">id:</span> | |
| 7286 | <span class="json-property-type">number</span> | |
| 7287 | <span class="json-property-range" title="Value limits"></span> | |
| 7288 | </dt> | |
| 7289 | <dt data-property-name="videoId"> | |
| 7290 | <span class="json-property-name">videoId:</span> | |
| 7291 | <span class="json-property-type">number</span> | |
| 7292 | <span class="json-property-range" title="Value limits"></span> | |
| 7293 | </dt> | |
| 7294 | <dt data-property-name="createdAt"> | |
| 7295 | <span class="json-property-name">createdAt:</span> | |
| 7296 | <span class="json-property-type">string</span> | |
| 7297 | <span class="json-property-range" title="Value limits"></span> | |
| 7298 | </dt> | |
| 7299 | <dt data-property-name="updatedAt"> | |
| 7300 | <span class="json-property-name">updatedAt:</span> | |
| 7301 | <span class="json-property-type">string</span> | |
| 7302 | <span class="json-property-range" title="Value limits"></span> | |
| 7303 | </dt> | |
| 7304 | <dt data-property-name="name"> | |
| 7305 | <span class="json-property-name">name:</span> | |
| 7306 | <span class="json-property-type">string</span> | |
| 7307 | <span class="json-property-range" title="Value limits"></span> | |
| 7308 | </dt> | |
| 7309 | <dt data-property-name="uuid"> | |
| 7310 | <span class="json-property-name">uuid:</span> | |
| 7311 | <span class="json-property-type">string</span> | |
| 7312 | <span class="json-property-range" title="Value limits"></span> | |
| 7313 | </dt> | |
| 7314 | <dt data-property-name="description"> | |
| 7315 | <span class="json-property-name">description:</span> | |
| 7316 | <span class="json-property-type">string</span> | |
| 7317 | <span class="json-property-range" title="Value limits"></span> | |
| 7318 | </dt> | |
| 7319 | <dt data-property-name="duration"> | |
| 7320 | <span class="json-property-name">duration:</span> | |
| 7321 | <span class="json-property-type">number</span> | |
| 7322 | <span class="json-property-range" title="Value limits"></span> | |
| 7323 | </dt> | |
| 7324 | <dt data-property-name="views"> | |
| 7325 | <span class="json-property-name">views:</span> | |
| 7326 | <span class="json-property-type">number</span> | |
| 7327 | <span class="json-property-range" title="Value limits"></span> | |
| 7328 | </dt> | |
| 7329 | <dt data-property-name="likes"> | |
| 7330 | <span class="json-property-name">likes:</span> | |
| 7331 | <span class="json-property-type">number</span> | |
| 7332 | <span class="json-property-range" title="Value limits"></span> | |
| 7333 | </dt> | |
| 7334 | <dt data-property-name="dislikes"> | |
| 7335 | <span class="json-property-name">dislikes:</span> | |
| 7336 | <span class="json-property-type">number</span> | |
| 7337 | <span class="json-property-range" title="Value limits"></span> | |
| 7338 | </dt> | |
| 7339 | <dt data-property-name="nsfw"> | |
| 7340 | <span class="json-property-name">nsfw:</span> | |
| 7341 | <span class="json-property-type">boolean</span> | |
| 7342 | <span class="json-property-range" title="Value limits"></span> | |
| 7343 | </dt> | |
| 7344 | </dl> | |
| 7345 | </section> | |
| 7346 | </div> | |
| 7347 | <div class="doc-examples"> | |
| 7348 | <section> | |
| 7349 | <h5>Example</h5> | |
| 7350 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7351 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7352 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 7353 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7354 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7355 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 7356 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 7357 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 7358 | <span class="hljs-attr">"duration"</span>: <span class="hljs-string">"number"</span>, | |
| 7359 | <span class="hljs-attr">"views"</span>: <span class="hljs-string">"number"</span>, | |
| 7360 | <span class="hljs-attr">"likes"</span>: <span class="hljs-string">"number"</span>, | |
| 7361 | <span class="hljs-attr">"dislikes"</span>: <span class="hljs-string">"number"</span>, | |
| 7362 | <span class="hljs-attr">"nsfw"</span>: <span class="hljs-string">"boolean"</span> | |
| 7363 | } | |
| 7364 | </code></pre> | |
| 7365 | <!-- </div> --> | |
| 7366 | </section> | |
| 7367 | </div> | |
| 7368 | </div> | |
| 7369 | </div> | |
| 7370 | <div id="definition-VideoChannel" class="definition panel" data-traverse-target="definition-VideoChannel"> | |
| 7371 | <h2 class="panel-title"> | |
| 7372 | <a name="/definitions/VideoChannel"></a>VideoChannel: | |
| 2963c343 | 7373 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
7374 | <span class="json-property-range" title="Value limits"></span> |
| 7375 | ||
| 7376 | ||
| 7377 | </span> --> | |
| 7378 | </h2> | |
| 7379 | <div class="doc-row"> | |
| 7380 | <div class="doc-copy"> | |
| 7381 | <section class="json-schema-properties"> | |
| 7382 | <dl> | |
| 7383 | <dt data-property-name="displayName"> | |
| 7384 | <span class="json-property-name">displayName:</span> | |
| 7385 | <span class="json-property-type">string</span> | |
| 7386 | <span class="json-property-range" title="Value limits"></span> | |
| 7387 | </dt> | |
| 7388 | <dt data-property-name="description"> | |
| 7389 | <span class="json-property-name">description:</span> | |
| 7390 | <span class="json-property-type">string</span> | |
| 7391 | <span class="json-property-range" title="Value limits"></span> | |
| 7392 | </dt> | |
| 7393 | <dt data-property-name="isLocal"> | |
| 7394 | <span class="json-property-name">isLocal:</span> | |
| 7395 | <span class="json-property-type">boolean</span> | |
| 7396 | <span class="json-property-range" title="Value limits"></span> | |
| 7397 | </dt> | |
| cc918ac3 C |
7398 | <dt data-property-name="ownerAccount"> |
| 7399 | <span class="json-property-name">ownerAccount:</span> | |
| 5e1c08eb C |
7400 | <span class="json-property-type">object</span> |
| 7401 | <span class="json-property-range" title="Value limits"></span> | |
| 7402 | </dt> | |
| ad9e39fb C |
7403 | <dt class="json-inner-schema"> |
| 7404 | <section class="json-schema-properties"> | |
| 7405 | <dl> | |
| 7406 | <dt data-property-name="id"> | |
| 7407 | <span class="json-property-name">id:</span> | |
| 7408 | <span class="json-property-type">number</span> | |
| 7409 | <span class="json-property-range" title="Value limits"></span> | |
| 7410 | </dt> | |
| 7411 | <dt data-property-name="uuid"> | |
| 7412 | <span class="json-property-name">uuid:</span> | |
| 7413 | <span class="json-property-type">string</span> | |
| 7414 | <span class="json-property-range" title="Value limits"></span> | |
| 7415 | </dt> | |
| 7416 | </dl> | |
| 7417 | </section> | |
| 7418 | </dt> | |
| 5e1c08eb C |
7419 | </dl> |
| 7420 | </section> | |
| 7421 | </div> | |
| 7422 | <div class="doc-examples"> | |
| 7423 | <section> | |
| 7424 | <h5>Example</h5> | |
| 7425 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7426 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 7427 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 7428 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| cc918ac3 C |
7429 | <span class="hljs-attr">"ownerAccount"</span>: { |
| 7430 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5e1c08eb | 7431 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> |
| cc918ac3 | 7432 | } |
| 5e1c08eb C |
7433 | } |
| 7434 | </code></pre> | |
| 7435 | <!-- </div> --> | |
| 7436 | </section> | |
| 7437 | </div> | |
| 7438 | </div> | |
| 7439 | </div> | |
| 7440 | <div id="definition-VideoComment" class="definition panel" data-traverse-target="definition-VideoComment"> | |
| 7441 | <h2 class="panel-title"> | |
| 7442 | <a name="/definitions/VideoComment"></a>VideoComment: | |
| 2963c343 | 7443 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
7444 | <span class="json-property-range" title="Value limits"></span> |
| 7445 | ||
| 7446 | ||
| 7447 | </span> --> | |
| 7448 | </h2> | |
| 7449 | <div class="doc-row"> | |
| 7450 | <div class="doc-copy"> | |
| 7451 | <section class="json-schema-properties"> | |
| 7452 | <dl> | |
| 7453 | <dt data-property-name="id"> | |
| 7454 | <span class="json-property-name">id:</span> | |
| 7455 | <span class="json-property-type">number</span> | |
| 7456 | <span class="json-property-range" title="Value limits"></span> | |
| 7457 | </dt> | |
| 7458 | <dt data-property-name="url"> | |
| 7459 | <span class="json-property-name">url:</span> | |
| 7460 | <span class="json-property-type">string</span> | |
| 7461 | <span class="json-property-range" title="Value limits"></span> | |
| 7462 | </dt> | |
| 7463 | <dt data-property-name="text"> | |
| 7464 | <span class="json-property-name">text:</span> | |
| 7465 | <span class="json-property-type">string</span> | |
| 7466 | <span class="json-property-range" title="Value limits"></span> | |
| 7467 | </dt> | |
| 7468 | <dt data-property-name="threadId"> | |
| 7469 | <span class="json-property-name">threadId:</span> | |
| 7470 | <span class="json-property-type">number</span> | |
| 7471 | <span class="json-property-range" title="Value limits"></span> | |
| 7472 | </dt> | |
| 7473 | <dt data-property-name="inReplyToCommentId"> | |
| 7474 | <span class="json-property-name">inReplyToCommentId:</span> | |
| 7475 | <span class="json-property-type">number</span> | |
| 7476 | <span class="json-property-range" title="Value limits"></span> | |
| 7477 | </dt> | |
| 7478 | <dt data-property-name="videoId"> | |
| 7479 | <span class="json-property-name">videoId:</span> | |
| 7480 | <span class="json-property-type">number</span> | |
| 7481 | <span class="json-property-range" title="Value limits"></span> | |
| 7482 | </dt> | |
| 7483 | <dt data-property-name="createdAt"> | |
| 7484 | <span class="json-property-name">createdAt:</span> | |
| 7485 | <span class="json-property-type">string</span> | |
| 7486 | <span class="json-property-range" title="Value limits"></span> | |
| 7487 | </dt> | |
| 7488 | <dt data-property-name="updatedAt"> | |
| 7489 | <span class="json-property-name">updatedAt:</span> | |
| 7490 | <span class="json-property-type">string</span> | |
| 7491 | <span class="json-property-range" title="Value limits"></span> | |
| 7492 | </dt> | |
| 7493 | <dt data-property-name="totalReplies"> | |
| 7494 | <span class="json-property-name">totalReplies:</span> | |
| 7495 | <span class="json-property-type">number</span> | |
| 7496 | <span class="json-property-range" title="Value limits"></span> | |
| 7497 | </dt> | |
| 7498 | <dt data-property-name="account"> | |
| 7499 | <span class="json-property-name">account:</span> | |
| 7500 | <span class="json-property-type"> | |
| 7501 | <span class=""> | |
| 7502 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
| 7503 | </span> | |
| 7504 | </span> | |
| 7505 | <span class="json-property-range" title="Value limits"></span> | |
| 7506 | </dt> | |
| 7507 | </dl> | |
| 7508 | </section> | |
| 7509 | </div> | |
| 7510 | <div class="doc-examples"> | |
| 7511 | <section> | |
| 7512 | <h5>Example</h5> | |
| 7513 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7514 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7515 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7516 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 7517 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 7518 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 7519 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 7520 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7521 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7522 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 7523 | <span class="hljs-attr">"account"</span>: { | |
| 7524 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 7525 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7526 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 7527 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7528 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 7529 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 7530 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7531 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7532 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7533 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7534 | <span class="hljs-attr">"avatar"</span>: { | |
| 7535 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 7536 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7537 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7538 | } | |
| 7539 | } | |
| 7540 | } | |
| 7541 | </code></pre> | |
| 7542 | <!-- </div> --> | |
| 7543 | </section> | |
| 7544 | </div> | |
| 7545 | </div> | |
| 7546 | </div> | |
| 7547 | <div id="definition-VideoCommentThreadTree" class="definition panel" data-traverse-target="definition-VideoCommentThreadTree"> | |
| 7548 | <h2 class="panel-title"> | |
| 7549 | <a name="/definitions/VideoCommentThreadTree"></a>VideoCommentThreadTree: | |
| 2963c343 | 7550 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
7551 | <span class="json-property-range" title="Value limits"></span> |
| 7552 | ||
| 7553 | ||
| 7554 | </span> --> | |
| 7555 | </h2> | |
| 7556 | <div class="doc-row"> | |
| 7557 | <div class="doc-copy"> | |
| 7558 | <section class="json-schema-properties"> | |
| 7559 | <dl> | |
| 7560 | <dt data-property-name="comment"> | |
| 7561 | <span class="json-property-name">comment:</span> | |
| 7562 | <span class="json-property-type"> | |
| 7563 | <span class=""> | |
| 7564 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | |
| 7565 | </span> | |
| 7566 | </span> | |
| 7567 | <span class="json-property-range" title="Value limits"></span> | |
| 7568 | </dt> | |
| 7569 | <dt data-property-name="children"> | |
| 7570 | <span class="json-property-name">children:</span> | |
| 7571 | <span class="json-property-type"> | |
| 7572 | <span class="json-schema-ref-array"> | |
| 7573 | <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a> | |
| 7574 | </span> | |
| 7575 | </span> | |
| 7576 | <span class="json-property-range" title="Value limits"></span> | |
| 7577 | </dt> | |
| ad9e39fb C |
7578 | <dt class="json-inner-schema"> |
| 7579 | <section class="json-schema-array-items"> | |
| 7580 | <span class="json-property-type"> | |
| 7581 | <span class=""> | |
| 7582 | <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a> | |
| 7583 | </span> | |
| 7584 | </span> | |
| 7585 | <span class="json-property-range" title="Value limits"></span> | |
| 7586 | <div class="json-inner-schema"> </div> | |
| 7587 | </section> | |
| 7588 | </dt> | |
| 5e1c08eb C |
7589 | </dl> |
| 7590 | </section> | |
| 7591 | </div> | |
| 7592 | <div class="doc-examples"> | |
| 7593 | <section> | |
| 7594 | <h5>Example</h5> | |
| 7595 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7596 | <span class="hljs-attr">"comment"</span>: { | |
| 7597 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7598 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7599 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 7600 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 7601 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 7602 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 7603 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7604 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7605 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 7606 | <span class="hljs-attr">"account"</span>: { | |
| 7607 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 7608 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7609 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 7610 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7611 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 7612 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 7613 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7614 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7615 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7616 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7617 | <span class="hljs-attr">"avatar"</span>: { | |
| 7618 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 7619 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7620 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7621 | } | |
| 7622 | } | |
| 7623 | }, | |
| 7624 | <span class="hljs-attr">"children"</span>: [ | |
| 7625 | { | |
| 7626 | <span class="hljs-attr">"comment"</span>: { | |
| 7627 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7628 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7629 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 7630 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 7631 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 7632 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 7633 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7634 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7635 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 7636 | <span class="hljs-attr">"account"</span>: { | |
| 7637 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 7638 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7639 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 7640 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7641 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 7642 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 7643 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7644 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7645 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7646 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7647 | <span class="hljs-attr">"avatar"</span>: { | |
| 7648 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 7649 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7650 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7651 | } | |
| 7652 | } | |
| 7653 | }, | |
| 7654 | <span class="hljs-attr">"children"</span>: [ | |
| 7655 | { | |
| 7656 | <span class="hljs-attr">"comment"</span>: { | |
| 7657 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7658 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7659 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 7660 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 7661 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 7662 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 7663 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7664 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7665 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 7666 | <span class="hljs-attr">"account"</span>: { | |
| 7667 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 7668 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7669 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 7670 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7671 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 7672 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 7673 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7674 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7675 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7676 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7677 | <span class="hljs-attr">"avatar"</span>: { | |
| 7678 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 7679 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7680 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7681 | } | |
| 7682 | } | |
| 7683 | } | |
| 7684 | } | |
| 7685 | ] | |
| 7686 | } | |
| 7687 | ] | |
| 7688 | } | |
| 7689 | </code></pre> | |
| 7690 | <!-- </div> --> | |
| 7691 | </section> | |
| 7692 | </div> | |
| 7693 | </div> | |
| 7694 | </div> | |
| 7695 | <div id="definition-Avatar" class="definition panel" data-traverse-target="definition-Avatar"> | |
| 7696 | <h2 class="panel-title"> | |
| 7697 | <a name="/definitions/Avatar"></a>Avatar: | |
| 2963c343 | 7698 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
7699 | <span class="json-property-range" title="Value limits"></span> |
| 7700 | ||
| 7701 | ||
| 7702 | </span> --> | |
| 7703 | </h2> | |
| 7704 | <div class="doc-row"> | |
| 7705 | <div class="doc-copy"> | |
| 7706 | <section class="json-schema-properties"> | |
| 7707 | <dl> | |
| 7708 | <dt data-property-name="path"> | |
| 7709 | <span class="json-property-name">path:</span> | |
| 7710 | <span class="json-property-type">string</span> | |
| 7711 | <span class="json-property-range" title="Value limits"></span> | |
| 7712 | </dt> | |
| 7713 | <dt data-property-name="createdAt"> | |
| 7714 | <span class="json-property-name">createdAt:</span> | |
| 7715 | <span class="json-property-type">string</span> | |
| 7716 | <span class="json-property-range" title="Value limits"></span> | |
| 7717 | </dt> | |
| 7718 | <dt data-property-name="updatedAt"> | |
| 7719 | <span class="json-property-name">updatedAt:</span> | |
| 7720 | <span class="json-property-type">string</span> | |
| 7721 | <span class="json-property-range" title="Value limits"></span> | |
| 7722 | </dt> | |
| 7723 | </dl> | |
| 7724 | </section> | |
| 7725 | </div> | |
| 7726 | <div class="doc-examples"> | |
| 7727 | <section> | |
| 7728 | <h5>Example</h5> | |
| 7729 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7730 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 7731 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7732 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7733 | } | |
| 7734 | </code></pre> | |
| 7735 | <!-- </div> --> | |
| 7736 | </section> | |
| 7737 | </div> | |
| 7738 | </div> | |
| 7739 | </div> | |
| 7740 | <div id="definition-Actor" class="definition panel" data-traverse-target="definition-Actor"> | |
| 7741 | <h2 class="panel-title"> | |
| 7742 | <a name="/definitions/Actor"></a>Actor: | |
| 2963c343 | 7743 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
7744 | <span class="json-property-range" title="Value limits"></span> |
| 7745 | ||
| 7746 | ||
| 7747 | </span> --> | |
| 7748 | </h2> | |
| 7749 | <div class="doc-row"> | |
| 7750 | <div class="doc-copy"> | |
| 7751 | <section class="json-schema-properties"> | |
| 7752 | <dl> | |
| 7753 | <dt data-property-name="id"> | |
| 7754 | <span class="json-property-name">id:</span> | |
| 7755 | <span class="json-property-type">number</span> | |
| 7756 | <span class="json-property-range" title="Value limits"></span> | |
| 7757 | </dt> | |
| 7758 | <dt data-property-name="uuid"> | |
| 7759 | <span class="json-property-name">uuid:</span> | |
| 7760 | <span class="json-property-type">string</span> | |
| 7761 | <span class="json-property-range" title="Value limits"></span> | |
| 7762 | </dt> | |
| 7763 | <dt data-property-name="url"> | |
| 7764 | <span class="json-property-name">url:</span> | |
| 7765 | <span class="json-property-type">string</span> | |
| 7766 | <span class="json-property-range" title="Value limits"></span> | |
| 7767 | </dt> | |
| 7768 | <dt data-property-name="name"> | |
| 7769 | <span class="json-property-name">name:</span> | |
| 7770 | <span class="json-property-type">string</span> | |
| 7771 | <span class="json-property-range" title="Value limits"></span> | |
| 7772 | </dt> | |
| 7773 | <dt data-property-name="host"> | |
| 7774 | <span class="json-property-name">host:</span> | |
| 7775 | <span class="json-property-type">string</span> | |
| 7776 | <span class="json-property-range" title="Value limits"></span> | |
| 7777 | </dt> | |
| 7778 | <dt data-property-name="followingCount"> | |
| 7779 | <span class="json-property-name">followingCount:</span> | |
| 7780 | <span class="json-property-type">number</span> | |
| 7781 | <span class="json-property-range" title="Value limits"></span> | |
| 7782 | </dt> | |
| 7783 | <dt data-property-name="followersCount"> | |
| 7784 | <span class="json-property-name">followersCount:</span> | |
| 7785 | <span class="json-property-type">number</span> | |
| 7786 | <span class="json-property-range" title="Value limits"></span> | |
| 7787 | </dt> | |
| 7788 | <dt data-property-name="createdAt"> | |
| 7789 | <span class="json-property-name">createdAt:</span> | |
| 7790 | <span class="json-property-type">string</span> | |
| 7791 | <span class="json-property-range" title="Value limits"></span> | |
| 7792 | </dt> | |
| 7793 | <dt data-property-name="updatedAt"> | |
| 7794 | <span class="json-property-name">updatedAt:</span> | |
| 7795 | <span class="json-property-type">string</span> | |
| 7796 | <span class="json-property-range" title="Value limits"></span> | |
| 7797 | </dt> | |
| 7798 | <dt data-property-name="avatar"> | |
| 7799 | <span class="json-property-name">avatar:</span> | |
| 7800 | <span class="json-property-type"> | |
| 7801 | <span class=""> | |
| 7802 | <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a> | |
| 7803 | </span> | |
| 7804 | </span> | |
| 7805 | <span class="json-property-range" title="Value limits"></span> | |
| 7806 | </dt> | |
| 7807 | </dl> | |
| 7808 | </section> | |
| 7809 | </div> | |
| 7810 | <div class="doc-examples"> | |
| 7811 | <section> | |
| 7812 | <h5>Example</h5> | |
| 7813 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7814 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7815 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 7816 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7817 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 7818 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 7819 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7820 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7821 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7822 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7823 | <span class="hljs-attr">"avatar"</span>: { | |
| 7824 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 7825 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7826 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7827 | } | |
| 7828 | } | |
| 7829 | </code></pre> | |
| 7830 | <!-- </div> --> | |
| 7831 | </section> | |
| 7832 | </div> | |
| 7833 | </div> | |
| 7834 | </div> | |
| 7835 | <div id="definition-Account" class="definition panel" data-traverse-target="definition-Account"> | |
| 7836 | <h2 class="panel-title"> | |
| 7837 | <a name="/definitions/Account"></a>Account: | |
| 2963c343 | 7838 | <!-- <span class="json-property-type"><span class="json-property-type"></span> |
| 5e1c08eb C |
7839 | <span class="json-property-range" title="Value limits"></span> |
| 7840 | ||
| 7841 | ||
| 7842 | </span> --> | |
| 7843 | </h2> | |
| 7844 | <div class="doc-row"> | |
| 7845 | <div class="doc-copy"> | |
| 7846 | <section class="json-schema-allOf"> | |
| 7847 | <section class="json-schema-allOf-inherited"> | |
| 7848 | <ul> | |
| 7849 | <span class=""> | |
| 7850 | <a class="json-schema-ref" href="#/definitions/Actor">Actor</a> | |
| 7851 | </span> | |
| 7852 | </ul> | |
| 7853 | </section> | |
| 7854 | <section class="json-schema-allOf-additional"> | |
| 7855 | <section class="json-schema-properties"> | |
| 7856 | <dl> | |
| 7857 | <dt data-property-name="displayName"> | |
| 7858 | <span class="json-property-name">displayName:</span> | |
| 7859 | <span class="json-property-type">string</span> | |
| 7860 | <span class="json-property-range" title="Value limits"></span> | |
| 7861 | </dt> | |
| 7862 | </dl> | |
| 7863 | </section> | |
| 7864 | </section> | |
| 7865 | </section> | |
| 7866 | </div> | |
| 7867 | <div class="doc-examples"> | |
| 7868 | <section> | |
| 7869 | <h5>Example</h5> | |
| 7870 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7871 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 7872 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7873 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 7874 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 7875 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 7876 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 7877 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7878 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 7879 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7880 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7881 | <span class="hljs-attr">"avatar"</span>: { | |
| 7882 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 7883 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7884 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 7885 | } | |
| 7886 | } | |
| 7887 | </code></pre> | |
| 7888 | <!-- </div> --> | |
| 7889 | </section> | |
| 7890 | </div> | |
| 7891 | </div> | |
| 7892 | </div> | |
| 7893 | <div id="definition-User" class="definition panel" data-traverse-target="definition-User"> | |
| 7894 | <h2 class="panel-title"> | |
| 7895 | <a name="/definitions/User"></a>User: | |
| 2963c343 | 7896 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
7897 | <span class="json-property-range" title="Value limits"></span> |
| 7898 | ||
| 7899 | ||
| 7900 | </span> --> | |
| 7901 | </h2> | |
| 7902 | <div class="doc-row"> | |
| 7903 | <div class="doc-copy"> | |
| 7904 | <section class="json-schema-properties"> | |
| 7905 | <dl> | |
| 7906 | <dt data-property-name="id"> | |
| 7907 | <span class="json-property-name">id:</span> | |
| 7908 | <span class="json-property-type">number</span> | |
| 7909 | <span class="json-property-range" title="Value limits"></span> | |
| 7910 | </dt> | |
| 7911 | <dt data-property-name="username"> | |
| 7912 | <span class="json-property-name">username:</span> | |
| 7913 | <span class="json-property-type">string</span> | |
| 7914 | <span class="json-property-range" title="Value limits"></span> | |
| 7915 | </dt> | |
| 7916 | <dt data-property-name="email"> | |
| 7917 | <span class="json-property-name">email:</span> | |
| 7918 | <span class="json-property-type">string</span> | |
| 7919 | <span class="json-property-range" title="Value limits"></span> | |
| 7920 | </dt> | |
| 7921 | <dt data-property-name="displayNSFW"> | |
| 7922 | <span class="json-property-name">displayNSFW:</span> | |
| 7923 | <span class="json-property-type">boolean</span> | |
| 7924 | <span class="json-property-range" title="Value limits"></span> | |
| 7925 | </dt> | |
| 7926 | <dt data-property-name="autoPlayVideo"> | |
| 7927 | <span class="json-property-name">autoPlayVideo:</span> | |
| 7928 | <span class="json-property-type">boolean</span> | |
| 7929 | <span class="json-property-range" title="Value limits"></span> | |
| 7930 | </dt> | |
| 7931 | <dt data-property-name="role"> | |
| 7932 | <span class="json-property-name">role:</span> | |
| 7933 | <span class="json-property-type">string</span> | |
| 7934 | <span class="json-property-enum" title="Possible values"> | |
| 7935 | <span class="json-property-enum-item">User</span>, | |
| 7936 | <span class="json-property-enum-item">Moderator</span>, | |
| 7937 | <span class="json-property-enum-item">Administrator</span> | |
| 7938 | </span> | |
| 7939 | <span class="json-property-range" title="Value limits"></span> | |
| 7940 | </dt> | |
| 7941 | <dt data-property-name="videoQuota"> | |
| 7942 | <span class="json-property-name">videoQuota:</span> | |
| 7943 | <span class="json-property-type">number</span> | |
| 7944 | <span class="json-property-range" title="Value limits"></span> | |
| 7945 | </dt> | |
| 7946 | <dt data-property-name="createdAt"> | |
| 7947 | <span class="json-property-name">createdAt:</span> | |
| 7948 | <span class="json-property-type">string</span> | |
| 7949 | <span class="json-property-range" title="Value limits"></span> | |
| 7950 | </dt> | |
| 7951 | <dt data-property-name="account"> | |
| 7952 | <span class="json-property-name">account:</span> | |
| 7953 | <span class="json-property-type"> | |
| 7954 | <span class=""> | |
| 7955 | <a class="json-schema-ref" href="#/definitions/Account">Account</a> | |
| 7956 | </span> | |
| 7957 | </span> | |
| 7958 | <span class="json-property-range" title="Value limits"></span> | |
| 7959 | </dt> | |
| 7960 | <dt data-property-name="videoChannels"> | |
| 7961 | <span class="json-property-name">videoChannels:</span> | |
| 7962 | <span class="json-property-type"> | |
| 7963 | <span class="json-schema-ref-array"> | |
| 7964 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
| 7965 | </span> | |
| 7966 | </span> | |
| 7967 | <span class="json-property-range" title="Value limits"></span> | |
| 7968 | </dt> | |
| ad9e39fb C |
7969 | <dt class="json-inner-schema"> |
| 7970 | <section class="json-schema-array-items"> | |
| 7971 | <span class="json-property-type"> | |
| 7972 | <span class=""> | |
| 7973 | <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a> | |
| 7974 | </span> | |
| 7975 | </span> | |
| 7976 | <span class="json-property-range" title="Value limits"></span> | |
| 7977 | <div class="json-inner-schema"> </div> | |
| 7978 | </section> | |
| 7979 | </dt> | |
| 5e1c08eb C |
7980 | </dl> |
| 7981 | </section> | |
| 7982 | </div> | |
| 7983 | <div class="doc-examples"> | |
| 7984 | <section> | |
| 7985 | <h5>Example</h5> | |
| 7986 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 7987 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7988 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
| 7989 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 7990 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"boolean"</span>, | |
| 7991 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"boolean"</span>, | |
| 7992 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>, | |
| 7993 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"number"</span>, | |
| 7994 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 7995 | <span class="hljs-attr">"account"</span>: { | |
| 7996 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 7997 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 7998 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 7999 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 8000 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 8001 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 8002 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 8003 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 8004 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8005 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8006 | <span class="hljs-attr">"avatar"</span>: { | |
| 8007 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 8008 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8009 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 8010 | } | |
| 8011 | }, | |
| 8012 | <span class="hljs-attr">"videoChannels"</span>: [ | |
| 8013 | { | |
| 8014 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 8015 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, | |
| 8016 | <span class="hljs-attr">"isLocal"</span>: <span class="hljs-string">"boolean"</span>, | |
| cc918ac3 C |
8017 | <span class="hljs-attr">"ownerAccount"</span>: { |
| 8018 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 5e1c08eb | 8019 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> |
| cc918ac3 | 8020 | } |
| 5e1c08eb C |
8021 | } |
| 8022 | ] | |
| 8023 | } | |
| 8024 | </code></pre> | |
| 8025 | <!-- </div> --> | |
| 8026 | </section> | |
| 8027 | </div> | |
| 8028 | </div> | |
| 8029 | </div> | |
| 8030 | <div id="definition-ServerConfig" class="definition panel" data-traverse-target="definition-ServerConfig"> | |
| 8031 | <h2 class="panel-title"> | |
| 8032 | <a name="/definitions/ServerConfig"></a>ServerConfig: | |
| 2963c343 | 8033 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
8034 | <span class="json-property-range" title="Value limits"></span> |
| 8035 | ||
| 8036 | ||
| 8037 | </span> --> | |
| 8038 | </h2> | |
| 8039 | <div class="doc-row"> | |
| 8040 | <div class="doc-copy"> | |
| 8041 | <section class="json-schema-properties"> | |
| 8042 | <dl> | |
| 8043 | <dt data-property-name="signup"> | |
| 8044 | <span class="json-property-name">signup:</span> | |
| 8045 | <span class="json-property-type">object</span> | |
| 8046 | <span class="json-property-range" title="Value limits"></span> | |
| 8047 | </dt> | |
| ad9e39fb C |
8048 | <dt class="json-inner-schema"> |
| 8049 | <section class="json-schema-properties"> | |
| 8050 | <dl> | |
| 8051 | <dt data-property-name="allowed"> | |
| 8052 | <span class="json-property-name">allowed:</span> | |
| 8053 | <span class="json-property-type">boolean</span> | |
| 8054 | <span class="json-property-range" title="Value limits"></span> | |
| 8055 | </dt> | |
| 8056 | </dl> | |
| 8057 | </section> | |
| 8058 | </dt> | |
| 5e1c08eb C |
8059 | <dt data-property-name="transcoding"> |
| 8060 | <span class="json-property-name">transcoding:</span> | |
| 8061 | <span class="json-property-type">object</span> | |
| 8062 | <span class="json-property-range" title="Value limits"></span> | |
| 8063 | </dt> | |
| ad9e39fb C |
8064 | <dt class="json-inner-schema"> |
| 8065 | <section class="json-schema-properties"> | |
| 8066 | <dl> | |
| 8067 | <dt data-property-name="enabledResolutions"> | |
| 8068 | <span class="json-property-name">enabledResolutions:</span> | |
| 8069 | <span class="json-property-type">number[]</span> | |
| 8070 | <span class="json-property-range" title="Value limits"></span> | |
| 8071 | </dt> | |
| 8072 | <dt class="json-inner-schema"> | |
| 8073 | <section class="json-schema-array-items"> | |
| 8074 | <span class="json-property-type">number</span> | |
| 8075 | <span class="json-property-range" title="Value limits"></span> | |
| 8076 | <div class="json-inner-schema"> </div> | |
| 8077 | </section> | |
| 8078 | </dt> | |
| 8079 | </dl> | |
| 8080 | </section> | |
| 8081 | </dt> | |
| 5e1c08eb C |
8082 | <dt data-property-name="avatar"> |
| 8083 | <span class="json-property-name">avatar:</span> | |
| 8084 | <span class="json-property-type">object</span> | |
| 8085 | <span class="json-property-range" title="Value limits"></span> | |
| 8086 | </dt> | |
| ad9e39fb C |
8087 | <dt class="json-inner-schema"> |
| 8088 | <section class="json-schema-properties"> | |
| 8089 | <dl> | |
| 8090 | <dt data-property-name="file"> | |
| 8091 | <span class="json-property-name">file:</span> | |
| 8092 | <span class="json-property-type">object</span> | |
| 8093 | <span class="json-property-range" title="Value limits"></span> | |
| 8094 | </dt> | |
| 8095 | <dt class="json-inner-schema"> | |
| 8096 | <section class="json-schema-properties"> | |
| 8097 | <dl> | |
| 8098 | <dt data-property-name="size"> | |
| 8099 | <span class="json-property-name">size:</span> | |
| 8100 | <span class="json-property-type">object</span> | |
| 8101 | <span class="json-property-range" title="Value limits"></span> | |
| 8102 | </dt> | |
| 8103 | <dt class="json-inner-schema"> | |
| 8104 | <section class="json-schema-properties"> | |
| 8105 | <dl> | |
| 8106 | <dt data-property-name="max"> | |
| 8107 | <span class="json-property-name">max:</span> | |
| 8108 | <span class="json-property-type">number</span> | |
| 8109 | <span class="json-property-range" title="Value limits"></span> | |
| 8110 | </dt> | |
| 8111 | </dl> | |
| 8112 | </section> | |
| 8113 | </dt> | |
| 8114 | </dl> | |
| 8115 | </section> | |
| 8116 | </dt> | |
| 8117 | <dt data-property-name="extensions"> | |
| 8118 | <span class="json-property-name">extensions:</span> | |
| 8119 | <span class="json-property-type">string[]</span> | |
| 8120 | <span class="json-property-range" title="Value limits"></span> | |
| 8121 | </dt> | |
| 8122 | <dt class="json-inner-schema"> | |
| 8123 | <section class="json-schema-array-items"> | |
| 8124 | <span class="json-property-type">string</span> | |
| 8125 | <span class="json-property-range" title="Value limits"></span> | |
| 8126 | <div class="json-inner-schema"> </div> | |
| 8127 | </section> | |
| 8128 | </dt> | |
| 8129 | </dl> | |
| 8130 | </section> | |
| 8131 | </dt> | |
| 5e1c08eb C |
8132 | <dt data-property-name="video"> |
| 8133 | <span class="json-property-name">video:</span> | |
| 8134 | <span class="json-property-type">object</span> | |
| 8135 | <span class="json-property-range" title="Value limits"></span> | |
| 8136 | </dt> | |
| ad9e39fb C |
8137 | <dt class="json-inner-schema"> |
| 8138 | <section class="json-schema-properties"> | |
| 8139 | <dl> | |
| 8140 | <dt data-property-name="file"> | |
| 8141 | <span class="json-property-name">file:</span> | |
| 8142 | <span class="json-property-type">object</span> | |
| 8143 | <span class="json-property-range" title="Value limits"></span> | |
| 8144 | </dt> | |
| 8145 | <dt class="json-inner-schema"> | |
| 8146 | <section class="json-schema-properties"> | |
| 8147 | <dl> | |
| 8148 | <dt data-property-name="extensions"> | |
| 8149 | <span class="json-property-name">extensions:</span> | |
| 8150 | <span class="json-property-type">string[]</span> | |
| 8151 | <span class="json-property-range" title="Value limits"></span> | |
| 8152 | </dt> | |
| 8153 | <dt class="json-inner-schema"> | |
| 8154 | <section class="json-schema-array-items"> | |
| 8155 | <span class="json-property-type">string</span> | |
| 8156 | <span class="json-property-range" title="Value limits"></span> | |
| 8157 | <div class="json-inner-schema"> </div> | |
| 8158 | </section> | |
| 8159 | </dt> | |
| 8160 | </dl> | |
| 8161 | </section> | |
| 8162 | </dt> | |
| 8163 | </dl> | |
| 8164 | </section> | |
| 8165 | </dt> | |
| 5e1c08eb C |
8166 | </dl> |
| 8167 | </section> | |
| 8168 | </div> | |
| 8169 | <div class="doc-examples"> | |
| 8170 | <section> | |
| 8171 | <h5>Example</h5> | |
| 8172 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 8173 | <span class="hljs-attr">"signup"</span>: { | |
| 8174 | <span class="hljs-attr">"allowed"</span>: <span class="hljs-string">"boolean"</span> | |
| 8175 | }, | |
| 8176 | <span class="hljs-attr">"transcoding"</span>: { | |
| 8177 | <span class="hljs-attr">"enabledResolutions"</span>: [ | |
| 8178 | <span class="hljs-string">"number"</span> | |
| 8179 | ] | |
| 8180 | }, | |
| 8181 | <span class="hljs-attr">"avatar"</span>: { | |
| 8182 | <span class="hljs-attr">"file"</span>: { | |
| 8183 | <span class="hljs-attr">"size"</span>: { | |
| 8184 | <span class="hljs-attr">"max"</span>: <span class="hljs-string">"number"</span> | |
| 8185 | } | |
| 8186 | }, | |
| 8187 | <span class="hljs-attr">"extensions"</span>: [ | |
| 8188 | <span class="hljs-string">"string"</span> | |
| 8189 | ] | |
| 8190 | }, | |
| 8191 | <span class="hljs-attr">"video"</span>: { | |
| 8192 | <span class="hljs-attr">"file"</span>: { | |
| 8193 | <span class="hljs-attr">"extensions"</span>: [ | |
| 8194 | <span class="hljs-string">"string"</span> | |
| 8195 | ] | |
| 8196 | } | |
| 8197 | } | |
| 8198 | } | |
| 8199 | </code></pre> | |
| 8200 | <!-- </div> --> | |
| 8201 | </section> | |
| 8202 | </div> | |
| 8203 | </div> | |
| 8204 | </div> | |
| 8205 | <div id="definition-Follow" class="definition panel" data-traverse-target="definition-Follow"> | |
| 8206 | <h2 class="panel-title"> | |
| 8207 | <a name="/definitions/Follow"></a>Follow: | |
| 2963c343 | 8208 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
8209 | <span class="json-property-range" title="Value limits"></span> |
| 8210 | ||
| 8211 | ||
| 8212 | </span> --> | |
| 8213 | </h2> | |
| 8214 | <div class="doc-row"> | |
| 8215 | <div class="doc-copy"> | |
| 8216 | <section class="json-schema-properties"> | |
| 8217 | <dl> | |
| 8218 | <dt data-property-name="id"> | |
| 8219 | <span class="json-property-name">id:</span> | |
| 8220 | <span class="json-property-type">number</span> | |
| 8221 | <span class="json-property-range" title="Value limits"></span> | |
| 8222 | </dt> | |
| 8223 | <dt data-property-name="follower"> | |
| 8224 | <span class="json-property-name">follower:</span> | |
| 8225 | <span class="json-property-type"> | |
| 8226 | <span class=""> | |
| 8227 | <a class="json-schema-ref" href="#/definitions/Actor">Actor</a> | |
| 8228 | </span> | |
| 8229 | </span> | |
| 8230 | <span class="json-property-range" title="Value limits"></span> | |
| 8231 | </dt> | |
| 8232 | <dt data-property-name="following"> | |
| 8233 | <span class="json-property-name">following:</span> | |
| 8234 | <span class="json-property-type"> | |
| 8235 | <span class=""> | |
| 8236 | <a class="json-schema-ref" href="#/definitions/Actor">Actor</a> | |
| 8237 | </span> | |
| 8238 | </span> | |
| 8239 | <span class="json-property-range" title="Value limits"></span> | |
| 8240 | </dt> | |
| 8241 | <dt data-property-name="score"> | |
| 8242 | <span class="json-property-name">score:</span> | |
| 8243 | <span class="json-property-type">number</span> | |
| 8244 | <span class="json-property-range" title="Value limits"></span> | |
| 8245 | </dt> | |
| 8246 | <dt data-property-name="state"> | |
| 8247 | <span class="json-property-name">state:</span> | |
| 8248 | <span class="json-property-type">string</span> | |
| 8249 | <span class="json-property-enum" title="Possible values"> | |
| 8250 | <span class="json-property-enum-item">pending</span>, | |
| 8251 | <span class="json-property-enum-item">accepted</span> | |
| 8252 | </span> | |
| 8253 | <span class="json-property-range" title="Value limits"></span> | |
| 8254 | </dt> | |
| 8255 | <dt data-property-name="createdAt"> | |
| 8256 | <span class="json-property-name">createdAt:</span> | |
| 8257 | <span class="json-property-type">string</span> | |
| 8258 | <span class="json-property-range" title="Value limits"></span> | |
| 8259 | </dt> | |
| 8260 | <dt data-property-name="updatedAt"> | |
| 8261 | <span class="json-property-name">updatedAt:</span> | |
| 8262 | <span class="json-property-type">string</span> | |
| 8263 | <span class="json-property-range" title="Value limits"></span> | |
| 8264 | </dt> | |
| 8265 | </dl> | |
| 8266 | </section> | |
| 8267 | </div> | |
| 8268 | <div class="doc-examples"> | |
| 8269 | <section> | |
| 8270 | <h5>Example</h5> | |
| 8271 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 8272 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 8273 | <span class="hljs-attr">"follower"</span>: { | |
| 8274 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 8275 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 8276 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 8277 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 8278 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 8279 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 8280 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 8281 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8282 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8283 | <span class="hljs-attr">"avatar"</span>: { | |
| 8284 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 8285 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8286 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 8287 | } | |
| 8288 | }, | |
| 8289 | <span class="hljs-attr">"following"</span>: { | |
| 8290 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 8291 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 8292 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 8293 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 8294 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 8295 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 8296 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 8297 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8298 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8299 | <span class="hljs-attr">"avatar"</span>: { | |
| 8300 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 8301 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8302 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 8303 | } | |
| 8304 | }, | |
| 8305 | <span class="hljs-attr">"score"</span>: <span class="hljs-string">"number"</span>, | |
| 8306 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
| 8307 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8308 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 8309 | } | |
| 8310 | </code></pre> | |
| 8311 | <!-- </div> --> | |
| 8312 | </section> | |
| 8313 | </div> | |
| 8314 | </div> | |
| 8315 | </div> | |
| 8316 | <div id="definition-Job" class="definition panel" data-traverse-target="definition-Job"> | |
| 8317 | <h2 class="panel-title"> | |
| 8318 | <a name="/definitions/Job"></a>Job: | |
| 2963c343 | 8319 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
8320 | <span class="json-property-range" title="Value limits"></span> |
| 8321 | ||
| 8322 | ||
| 8323 | </span> --> | |
| 8324 | </h2> | |
| 8325 | <div class="doc-row"> | |
| 8326 | <div class="doc-copy"> | |
| 8327 | <section class="json-schema-properties"> | |
| 8328 | <dl> | |
| 8329 | <dt data-property-name="id"> | |
| 8330 | <span class="json-property-name">id:</span> | |
| 8331 | <span class="json-property-type">number</span> | |
| 8332 | <span class="json-property-range" title="Value limits"></span> | |
| 8333 | </dt> | |
| 8334 | <dt data-property-name="state"> | |
| 8335 | <span class="json-property-name">state:</span> | |
| 8336 | <span class="json-property-type">string</span> | |
| 8337 | <span class="json-property-enum" title="Possible values"> | |
| 8338 | <span class="json-property-enum-item">pending</span>, | |
| 8339 | <span class="json-property-enum-item">processing</span>, | |
| 8340 | <span class="json-property-enum-item">error</span>, | |
| 8341 | <span class="json-property-enum-item">success</span> | |
| 8342 | </span> | |
| 8343 | <span class="json-property-range" title="Value limits"></span> | |
| 8344 | </dt> | |
| 8345 | <dt data-property-name="category"> | |
| 8346 | <span class="json-property-name">category:</span> | |
| 8347 | <span class="json-property-type">string</span> | |
| 8348 | <span class="json-property-enum" title="Possible values"> | |
| 8349 | <span class="json-property-enum-item">transcoding</span>, | |
| 8350 | <span class="json-property-enum-item">activitypub-http</span> | |
| 8351 | </span> | |
| 8352 | <span class="json-property-range" title="Value limits"></span> | |
| 8353 | </dt> | |
| 8354 | <dt data-property-name="handlerName"> | |
| 8355 | <span class="json-property-name">handlerName:</span> | |
| 8356 | <span class="json-property-type">string</span> | |
| 8357 | <span class="json-property-range" title="Value limits"></span> | |
| 8358 | </dt> | |
| 8359 | <dt data-property-name="handlerInputData"> | |
| 8360 | <span class="json-property-name">handlerInputData:</span> | |
| 8361 | <span class="json-property-type">string</span> | |
| 8362 | <span class="json-property-range" title="Value limits"></span> | |
| 8363 | </dt> | |
| 8364 | <dt data-property-name="createdAt"> | |
| 8365 | <span class="json-property-name">createdAt:</span> | |
| 8366 | <span class="json-property-type">string</span> | |
| 8367 | <span class="json-property-range" title="Value limits"></span> | |
| 8368 | </dt> | |
| 8369 | <dt data-property-name="updatedAt"> | |
| 8370 | <span class="json-property-name">updatedAt:</span> | |
| 8371 | <span class="json-property-type">string</span> | |
| 8372 | <span class="json-property-range" title="Value limits"></span> | |
| 8373 | </dt> | |
| 8374 | </dl> | |
| 8375 | </section> | |
| 8376 | </div> | |
| 8377 | <div class="doc-examples"> | |
| 8378 | <section> | |
| 8379 | <h5>Example</h5> | |
| 8380 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 8381 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 8382 | <span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>, | |
| 8383 | <span class="hljs-attr">"category"</span>: <span class="hljs-string">"string"</span>, | |
| 8384 | <span class="hljs-attr">"handlerName"</span>: <span class="hljs-string">"string"</span>, | |
| 8385 | <span class="hljs-attr">"handlerInputData"</span>: <span class="hljs-string">"string"</span>, | |
| 8386 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8387 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 8388 | } | |
| 8389 | </code></pre> | |
| 8390 | <!-- </div> --> | |
| 8391 | </section> | |
| 8392 | </div> | |
| 8393 | </div> | |
| 8394 | </div> | |
| 8395 | <div id="definition-AddUserResponse" class="definition panel" data-traverse-target="definition-AddUserResponse"> | |
| 8396 | <h2 class="panel-title"> | |
| 8397 | <a name="/definitions/AddUserResponse"></a>AddUserResponse: | |
| 2963c343 | 8398 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
8399 | <span class="json-property-range" title="Value limits"></span> |
| 8400 | ||
| 8401 | ||
| 8402 | </span> --> | |
| 8403 | </h2> | |
| 8404 | <div class="doc-row"> | |
| 8405 | <div class="doc-copy"> | |
| 8406 | <section class="json-schema-properties"> | |
| 8407 | <dl> | |
| 8408 | <dt data-property-name="id"> | |
| 8409 | <span class="json-property-name">id:</span> | |
| 8410 | <span class="json-property-type">number</span> | |
| 8411 | <span class="json-property-range" title="Value limits"></span> | |
| 8412 | </dt> | |
| 8413 | <dt data-property-name="uuid"> | |
| 8414 | <span class="json-property-name">uuid:</span> | |
| 8415 | <span class="json-property-type">string</span> | |
| 8416 | <span class="json-property-range" title="Value limits"></span> | |
| 8417 | </dt> | |
| 8418 | </dl> | |
| 8419 | </section> | |
| 8420 | </div> | |
| 8421 | <div class="doc-examples"> | |
| 8422 | <section> | |
| 8423 | <h5>Example</h5> | |
| 8424 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 8425 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 8426 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
| 8427 | } | |
| 8428 | </code></pre> | |
| 8429 | <!-- </div> --> | |
| 8430 | </section> | |
| 8431 | </div> | |
| 8432 | </div> | |
| 8433 | </div> | |
| 8434 | <div id="definition-VideoUploadResponse" class="definition panel" data-traverse-target="definition-VideoUploadResponse"> | |
| 8435 | <h2 class="panel-title"> | |
| 8436 | <a name="/definitions/VideoUploadResponse"></a>VideoUploadResponse: | |
| 2963c343 | 8437 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
8438 | <span class="json-property-range" title="Value limits"></span> |
| 8439 | ||
| 8440 | ||
| 8441 | </span> --> | |
| 8442 | </h2> | |
| 8443 | <div class="doc-row"> | |
| 8444 | <div class="doc-copy"> | |
| 8445 | <section class="json-schema-properties"> | |
| 8446 | <dl> | |
| 61b66b36 C |
8447 | <dt data-property-name="video"> |
| 8448 | <span class="json-property-name">video:</span> | |
| 8449 | <span class="json-property-type">object</span> | |
| 5e1c08eb C |
8450 | <span class="json-property-range" title="Value limits"></span> |
| 8451 | </dt> | |
| ad9e39fb C |
8452 | <dt class="json-inner-schema"> |
| 8453 | <section class="json-schema-properties"> | |
| 8454 | <dl> | |
| 8455 | <dt data-property-name="id"> | |
| 8456 | <span class="json-property-name">id:</span> | |
| 8457 | <span class="json-property-type">number</span> | |
| 8458 | <span class="json-property-range" title="Value limits"></span> | |
| 8459 | </dt> | |
| 8460 | <dt data-property-name="uuid"> | |
| 8461 | <span class="json-property-name">uuid:</span> | |
| 8462 | <span class="json-property-type">string</span> | |
| 8463 | <span class="json-property-range" title="Value limits"></span> | |
| 8464 | </dt> | |
| 8465 | </dl> | |
| 8466 | </section> | |
| 8467 | </dt> | |
| 5e1c08eb C |
8468 | </dl> |
| 8469 | </section> | |
| 8470 | </div> | |
| 8471 | <div class="doc-examples"> | |
| 8472 | <section> | |
| 8473 | <h5>Example</h5> | |
| 8474 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 61b66b36 C |
8475 | <span class="hljs-attr">"video"</span>: { |
| 8476 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 8477 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span> | |
| 8478 | } | |
| 5e1c08eb | 8479 | } |
| ab0ee6a1 C |
8480 | </code></pre> |
| 8481 | <!-- </div> --> | |
| 8482 | </section> | |
| 8483 | </div> | |
| 8484 | </div> | |
| 8485 | </div> | |
| 8486 | <div id="definition-CommentThreadResponse" class="definition panel" data-traverse-target="definition-CommentThreadResponse"> | |
| 8487 | <h2 class="panel-title"> | |
| 8488 | <a name="/definitions/CommentThreadResponse"></a>CommentThreadResponse: | |
| 2963c343 | 8489 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| ab0ee6a1 C |
8490 | <span class="json-property-range" title="Value limits"></span> |
| 8491 | ||
| 8492 | ||
| 8493 | </span> --> | |
| 8494 | </h2> | |
| 8495 | <div class="doc-row"> | |
| 8496 | <div class="doc-copy"> | |
| 8497 | <section class="json-schema-properties"> | |
| 8498 | <dl> | |
| 8499 | <dt data-property-name="total"> | |
| 8500 | <span class="json-property-name">total:</span> | |
| 8501 | <span class="json-property-type">number</span> | |
| 8502 | <span class="json-property-range" title="Value limits"></span> | |
| 8503 | </dt> | |
| 8504 | <dt data-property-name="data"> | |
| 8505 | <span class="json-property-name">data:</span> | |
| 8506 | <span class="json-property-type"> | |
| 8507 | <span class="json-schema-ref-array"> | |
| 8508 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | |
| 8509 | </span> | |
| 8510 | </span> | |
| 8511 | <span class="json-property-range" title="Value limits"></span> | |
| 8512 | </dt> | |
| ad9e39fb C |
8513 | <dt class="json-inner-schema"> |
| 8514 | <section class="json-schema-array-items"> | |
| 8515 | <span class="json-property-type"> | |
| 8516 | <span class=""> | |
| 8517 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | |
| 8518 | </span> | |
| 8519 | </span> | |
| 8520 | <span class="json-property-range" title="Value limits"></span> | |
| 8521 | <div class="json-inner-schema"> </div> | |
| 8522 | </section> | |
| 8523 | </dt> | |
| ab0ee6a1 C |
8524 | </dl> |
| 8525 | </section> | |
| 8526 | </div> | |
| 8527 | <div class="doc-examples"> | |
| 8528 | <section> | |
| 8529 | <h5>Example</h5> | |
| 8530 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 8531 | <span class="hljs-attr">"total"</span>: <span class="hljs-string">"number"</span>, | |
| 8532 | <span class="hljs-attr">"data"</span>: [ | |
| 8533 | { | |
| 8534 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 8535 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 8536 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 8537 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 8538 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 8539 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 8540 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8541 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8542 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 8543 | <span class="hljs-attr">"account"</span>: { | |
| 8544 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 8545 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 8546 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 8547 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 8548 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 8549 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 8550 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 8551 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 8552 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8553 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8554 | <span class="hljs-attr">"avatar"</span>: { | |
| 8555 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 8556 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8557 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 8558 | } | |
| 8559 | } | |
| 8560 | } | |
| 8561 | ] | |
| 8562 | } | |
| 8563 | </code></pre> | |
| 8564 | <!-- </div> --> | |
| 8565 | </section> | |
| 8566 | </div> | |
| 8567 | </div> | |
| 8568 | </div> | |
| 8569 | <div id="definition-CommentThreadPostResponse" class="definition panel" data-traverse-target="definition-CommentThreadPostResponse"> | |
| 8570 | <h2 class="panel-title"> | |
| 8571 | <a name="/definitions/CommentThreadPostResponse"></a>CommentThreadPostResponse: | |
| 2963c343 | 8572 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| ab0ee6a1 C |
8573 | <span class="json-property-range" title="Value limits"></span> |
| 8574 | ||
| 8575 | ||
| 8576 | </span> --> | |
| 8577 | </h2> | |
| 8578 | <div class="doc-row"> | |
| 8579 | <div class="doc-copy"> | |
| 8580 | <section class="json-schema-properties"> | |
| 8581 | <dl> | |
| 8582 | <dt data-property-name="comment"> | |
| 8583 | <span class="json-property-name">comment:</span> | |
| 8584 | <span class="json-property-type"> | |
| 8585 | <span class=""> | |
| 8586 | <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a> | |
| 8587 | </span> | |
| 8588 | </span> | |
| 8589 | <span class="json-property-range" title="Value limits"></span> | |
| 8590 | </dt> | |
| 8591 | </dl> | |
| 8592 | </section> | |
| 8593 | </div> | |
| 8594 | <div class="doc-examples"> | |
| 8595 | <section> | |
| 8596 | <h5>Example</h5> | |
| 8597 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 8598 | <span class="hljs-attr">"comment"</span>: { | |
| 8599 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 8600 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 8601 | <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, | |
| 8602 | <span class="hljs-attr">"threadId"</span>: <span class="hljs-string">"number"</span>, | |
| 8603 | <span class="hljs-attr">"inReplyToCommentId"</span>: <span class="hljs-string">"number"</span>, | |
| 8604 | <span class="hljs-attr">"videoId"</span>: <span class="hljs-string">"number"</span>, | |
| 8605 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8606 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8607 | <span class="hljs-attr">"totalReplies"</span>: <span class="hljs-string">"number"</span>, | |
| 8608 | <span class="hljs-attr">"account"</span>: { | |
| 8609 | <span class="hljs-attr">"displayName"</span>: <span class="hljs-string">"string"</span>, | |
| 8610 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"number"</span>, | |
| 8611 | <span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>, | |
| 8612 | <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, | |
| 8613 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 8614 | <span class="hljs-attr">"host"</span>: <span class="hljs-string">"string"</span>, | |
| 8615 | <span class="hljs-attr">"followingCount"</span>: <span class="hljs-string">"number"</span>, | |
| 8616 | <span class="hljs-attr">"followersCount"</span>: <span class="hljs-string">"number"</span>, | |
| 8617 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8618 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8619 | <span class="hljs-attr">"avatar"</span>: { | |
| 8620 | <span class="hljs-attr">"path"</span>: <span class="hljs-string">"string"</span>, | |
| 8621 | <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, | |
| 8622 | <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span> | |
| 8623 | } | |
| 8624 | } | |
| 8625 | } | |
| 8626 | } | |
| 5e1c08eb C |
8627 | </code></pre> |
| 8628 | <!-- </div> --> | |
| 8629 | </section> | |
| 8630 | </div> | |
| 8631 | </div> | |
| 8632 | </div> | |
| 8633 | <div id="definition-AddUser" class="definition panel" data-traverse-target="definition-AddUser"> | |
| 8634 | <h2 class="panel-title"> | |
| 8635 | <a name="/definitions/AddUser"></a>AddUser: | |
| 2963c343 | 8636 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
8637 | <span class="json-property-range" title="Value limits"></span> |
| 8638 | ||
| 8639 | ||
| 8640 | </span> --> | |
| 8641 | </h2> | |
| 8642 | <div class="doc-row"> | |
| 8643 | <div class="doc-copy"> | |
| 8644 | <section class="json-schema-properties"> | |
| 8645 | <dl> | |
| 8646 | <dt data-property-name="username" class="has-description"> | |
| 8647 | <span class="json-property-name">username:</span> | |
| 8648 | <span class="json-property-type">string</span> | |
| 8649 | <span class="json-property-range" title="Value limits"></span> | |
| 8650 | <span class="json-property-required"></span> | |
| 8651 | </dt> | |
| 8652 | <dd> | |
| 8653 | <p>The user username </p> | |
| 8654 | </dd> | |
| 8655 | <dt data-property-name="password" class="has-description"> | |
| 8656 | <span class="json-property-name">password:</span> | |
| 8657 | <span class="json-property-type">string</span> | |
| 8658 | <span class="json-property-range" title="Value limits"></span> | |
| 8659 | <span class="json-property-required"></span> | |
| 8660 | </dt> | |
| 8661 | <dd> | |
| 8662 | <p>The user password </p> | |
| 8663 | </dd> | |
| 8664 | <dt data-property-name="email" class="has-description"> | |
| 8665 | <span class="json-property-name">email:</span> | |
| 8666 | <span class="json-property-type">string</span> | |
| 8667 | <span class="json-property-range" title="Value limits"></span> | |
| 8668 | <span class="json-property-required"></span> | |
| 8669 | </dt> | |
| 8670 | <dd> | |
| 8671 | <p>The user email </p> | |
| 8672 | </dd> | |
| 8673 | <dt data-property-name="videoQuota" class="has-description"> | |
| 8674 | <span class="json-property-name">videoQuota:</span> | |
| 8675 | <span class="json-property-type">string</span> | |
| 8676 | <span class="json-property-range" title="Value limits"></span> | |
| 8677 | <span class="json-property-required"></span> | |
| 8678 | </dt> | |
| 8679 | <dd> | |
| 8680 | <p>The user videoQuota </p> | |
| 8681 | </dd> | |
| 8682 | <dt data-property-name="role" class="has-description"> | |
| 8683 | <span class="json-property-name">role:</span> | |
| 8684 | <span class="json-property-type">string</span> | |
| 8685 | <span class="json-property-range" title="Value limits"></span> | |
| 8686 | <span class="json-property-required"></span> | |
| 8687 | </dt> | |
| 8688 | <dd> | |
| 8689 | <p>The user role </p> | |
| 8690 | </dd> | |
| 8691 | </dl> | |
| 8692 | </section> | |
| 8693 | </div> | |
| 8694 | <div class="doc-examples"> | |
| 8695 | <section> | |
| 8696 | <h5>Example</h5> | |
| 8697 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 8698 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
| 8699 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
| 8700 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 8701 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
| 8702 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
| 8703 | } | |
| 8704 | </code></pre> | |
| 8705 | <!-- </div> --> | |
| 8706 | </section> | |
| 8707 | </div> | |
| 8708 | </div> | |
| 8709 | </div> | |
| 8710 | <div id="definition-UpdateUser" class="definition panel" data-traverse-target="definition-UpdateUser"> | |
| 8711 | <h2 class="panel-title"> | |
| 8712 | <a name="/definitions/UpdateUser"></a>UpdateUser: | |
| 2963c343 | 8713 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
8714 | <span class="json-property-range" title="Value limits"></span> |
| 8715 | ||
| 8716 | ||
| 8717 | </span> --> | |
| 8718 | </h2> | |
| 8719 | <div class="doc-row"> | |
| 8720 | <div class="doc-copy"> | |
| 8721 | <section class="json-schema-properties"> | |
| 8722 | <dl> | |
| 8723 | <dt data-property-name="id" class="has-description"> | |
| 8724 | <span class="json-property-name">id:</span> | |
| 8725 | <span class="json-property-type">string</span> | |
| 8726 | <span class="json-property-range" title="Value limits"></span> | |
| 8727 | <span class="json-property-required"></span> | |
| 8728 | </dt> | |
| 8729 | <dd> | |
| 8730 | <p>The user id </p> | |
| 8731 | </dd> | |
| 8732 | <dt data-property-name="email" class="has-description"> | |
| 8733 | <span class="json-property-name">email:</span> | |
| 8734 | <span class="json-property-type">string</span> | |
| 8735 | <span class="json-property-range" title="Value limits"></span> | |
| 8736 | <span class="json-property-required"></span> | |
| 8737 | </dt> | |
| 8738 | <dd> | |
| 8739 | <p>The updated email of the user </p> | |
| 8740 | </dd> | |
| 8741 | <dt data-property-name="videoQuota" class="has-description"> | |
| 8742 | <span class="json-property-name">videoQuota:</span> | |
| 8743 | <span class="json-property-type">string</span> | |
| 8744 | <span class="json-property-range" title="Value limits"></span> | |
| 8745 | <span class="json-property-required"></span> | |
| 8746 | </dt> | |
| 8747 | <dd> | |
| 8748 | <p>The updated videoQuota of the user </p> | |
| 8749 | </dd> | |
| 8750 | <dt data-property-name="role" class="has-description"> | |
| 8751 | <span class="json-property-name">role:</span> | |
| 8752 | <span class="json-property-type">string</span> | |
| 8753 | <span class="json-property-range" title="Value limits"></span> | |
| 8754 | <span class="json-property-required"></span> | |
| 8755 | </dt> | |
| 8756 | <dd> | |
| 8757 | <p>The updated role of the user </p> | |
| 8758 | </dd> | |
| 8759 | </dl> | |
| 8760 | </section> | |
| 8761 | </div> | |
| 8762 | <div class="doc-examples"> | |
| 8763 | <section> | |
| 8764 | <h5>Example</h5> | |
| 8765 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 8766 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
| 8767 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 8768 | <span class="hljs-attr">"videoQuota"</span>: <span class="hljs-string">"string"</span>, | |
| 8769 | <span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span> | |
| 8770 | } | |
| 8771 | </code></pre> | |
| 8772 | <!-- </div> --> | |
| 8773 | </section> | |
| 8774 | </div> | |
| 8775 | </div> | |
| 8776 | </div> | |
| 8777 | <div id="definition-UpdateMe" class="definition panel" data-traverse-target="definition-UpdateMe"> | |
| 8778 | <h2 class="panel-title"> | |
| 8779 | <a name="/definitions/UpdateMe"></a>UpdateMe: | |
| 2963c343 | 8780 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
8781 | <span class="json-property-range" title="Value limits"></span> |
| 8782 | ||
| 8783 | ||
| 8784 | </span> --> | |
| 8785 | </h2> | |
| 8786 | <div class="doc-row"> | |
| 8787 | <div class="doc-copy"> | |
| 8788 | <section class="json-schema-properties"> | |
| 8789 | <dl> | |
| 8790 | <dt data-property-name="password" class="has-description"> | |
| 8791 | <span class="json-property-name">password:</span> | |
| 8792 | <span class="json-property-type">string</span> | |
| 8793 | <span class="json-property-range" title="Value limits"></span> | |
| 8794 | <span class="json-property-required"></span> | |
| 8795 | </dt> | |
| 8796 | <dd> | |
| 8797 | <p>Your new password </p> | |
| 8798 | </dd> | |
| 8799 | <dt data-property-name="email" class="has-description"> | |
| 8800 | <span class="json-property-name">email:</span> | |
| 8801 | <span class="json-property-type">string</span> | |
| 8802 | <span class="json-property-range" title="Value limits"></span> | |
| 8803 | <span class="json-property-required"></span> | |
| 8804 | </dt> | |
| 8805 | <dd> | |
| 8806 | <p>Your new email </p> | |
| 8807 | </dd> | |
| 8808 | <dt data-property-name="displayNSFW" class="has-description"> | |
| 8809 | <span class="json-property-name">displayNSFW:</span> | |
| 8810 | <span class="json-property-type">string</span> | |
| 8811 | <span class="json-property-range" title="Value limits"></span> | |
| 8812 | <span class="json-property-required"></span> | |
| 8813 | </dt> | |
| 8814 | <dd> | |
| 8815 | <p>Your new displayNSFW </p> | |
| 8816 | </dd> | |
| 8817 | <dt data-property-name="autoPlayVideo" class="has-description"> | |
| 8818 | <span class="json-property-name">autoPlayVideo:</span> | |
| 8819 | <span class="json-property-type">string</span> | |
| 8820 | <span class="json-property-range" title="Value limits"></span> | |
| 8821 | <span class="json-property-required"></span> | |
| 8822 | </dt> | |
| 8823 | <dd> | |
| 8824 | <p>Your new autoPlayVideo </p> | |
| 8825 | </dd> | |
| 8826 | </dl> | |
| 8827 | </section> | |
| 8828 | </div> | |
| 8829 | <div class="doc-examples"> | |
| 8830 | <section> | |
| 8831 | <h5>Example</h5> | |
| 8832 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 8833 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
| 8834 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>, | |
| 8835 | <span class="hljs-attr">"displayNSFW"</span>: <span class="hljs-string">"string"</span>, | |
| 8836 | <span class="hljs-attr">"autoPlayVideo"</span>: <span class="hljs-string">"string"</span> | |
| 8837 | } | |
| 8838 | </code></pre> | |
| 8839 | <!-- </div> --> | |
| 8840 | </section> | |
| 8841 | </div> | |
| 8842 | </div> | |
| 8843 | </div> | |
| 8844 | <div id="definition-GetMeVideoRating" class="definition panel" data-traverse-target="definition-GetMeVideoRating"> | |
| 8845 | <h2 class="panel-title"> | |
| 8846 | <a name="/definitions/GetMeVideoRating"></a>GetMeVideoRating: | |
| 2963c343 | 8847 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
8848 | <span class="json-property-range" title="Value limits"></span> |
| 8849 | ||
| 8850 | ||
| 8851 | </span> --> | |
| 8852 | </h2> | |
| 8853 | <div class="doc-row"> | |
| 8854 | <div class="doc-copy"> | |
| 8855 | <section class="json-schema-properties"> | |
| 8856 | <dl> | |
| 8857 | <dt data-property-name="id" class="has-description"> | |
| 8858 | <span class="json-property-name">id:</span> | |
| 8859 | <span class="json-property-type">string</span> | |
| 8860 | <span class="json-property-range" title="Value limits"></span> | |
| 8861 | <span class="json-property-required"></span> | |
| 8862 | </dt> | |
| 8863 | <dd> | |
| 8864 | <p>Id of the video </p> | |
| 8865 | </dd> | |
| 8866 | <dt data-property-name="rating" class="has-description"> | |
| 8867 | <span class="json-property-name">rating:</span> | |
| 8868 | <span class="json-property-type">number</span> | |
| 8869 | <span class="json-property-range" title="Value limits"></span> | |
| 8870 | <span class="json-property-required"></span> | |
| 8871 | </dt> | |
| 8872 | <dd> | |
| 8873 | <p>Rating of the video </p> | |
| 8874 | </dd> | |
| 8875 | </dl> | |
| 8876 | </section> | |
| 8877 | </div> | |
| 8878 | <div class="doc-examples"> | |
| 8879 | <section> | |
| 8880 | <h5>Example</h5> | |
| 8881 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 8882 | <span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>, | |
| 8883 | <span class="hljs-attr">"rating"</span>: <span class="hljs-string">"number"</span> | |
| 8884 | } | |
| 8885 | </code></pre> | |
| 8886 | <!-- </div> --> | |
| 8887 | </section> | |
| 8888 | </div> | |
| 8889 | </div> | |
| 8890 | </div> | |
| 8891 | <div id="definition-RegisterUser" class="definition panel" data-traverse-target="definition-RegisterUser"> | |
| 8892 | <h2 class="panel-title"> | |
| 8893 | <a name="/definitions/RegisterUser"></a>RegisterUser: | |
| 2963c343 | 8894 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
8895 | <span class="json-property-range" title="Value limits"></span> |
| 8896 | ||
| 8897 | ||
| 8898 | </span> --> | |
| 8899 | </h2> | |
| 8900 | <div class="doc-row"> | |
| 8901 | <div class="doc-copy"> | |
| 8902 | <section class="json-schema-properties"> | |
| 8903 | <dl> | |
| 8904 | <dt data-property-name="username" class="has-description"> | |
| 8905 | <span class="json-property-name">username:</span> | |
| 8906 | <span class="json-property-type">string</span> | |
| 8907 | <span class="json-property-range" title="Value limits"></span> | |
| 8908 | <span class="json-property-required"></span> | |
| 8909 | </dt> | |
| 8910 | <dd> | |
| 8911 | <p>The username of the user </p> | |
| 8912 | </dd> | |
| 8913 | <dt data-property-name="password" class="has-description"> | |
| 8914 | <span class="json-property-name">password:</span> | |
| 8915 | <span class="json-property-type">string</span> | |
| 8916 | <span class="json-property-range" title="Value limits"></span> | |
| 8917 | <span class="json-property-required"></span> | |
| 8918 | </dt> | |
| 8919 | <dd> | |
| 8920 | <p>The password of the user </p> | |
| 8921 | </dd> | |
| 8922 | <dt data-property-name="email" class="has-description"> | |
| 8923 | <span class="json-property-name">email:</span> | |
| 8924 | <span class="json-property-type">string</span> | |
| 8925 | <span class="json-property-range" title="Value limits"></span> | |
| 8926 | <span class="json-property-required"></span> | |
| 8927 | </dt> | |
| 8928 | <dd> | |
| 8929 | <p>The email of the user </p> | |
| 8930 | </dd> | |
| 8931 | </dl> | |
| 8932 | </section> | |
| 8933 | </div> | |
| 8934 | <div class="doc-examples"> | |
| 8935 | <section> | |
| 8936 | <h5>Example</h5> | |
| 8937 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 8938 | <span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>, | |
| 8939 | <span class="hljs-attr">"password"</span>: <span class="hljs-string">"string"</span>, | |
| 8940 | <span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span> | |
| 8941 | } | |
| 8942 | </code></pre> | |
| 8943 | <!-- </div> --> | |
| 8944 | </section> | |
| 8945 | </div> | |
| 8946 | </div> | |
| 8947 | </div> | |
| 8948 | <div id="definition-VideoChannelInput" class="definition panel" data-traverse-target="definition-VideoChannelInput"> | |
| 8949 | <h2 class="panel-title"> | |
| 8950 | <a name="/definitions/VideoChannelInput"></a>VideoChannelInput: | |
| 2963c343 | 8951 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> |
| 5e1c08eb C |
8952 | <span class="json-property-range" title="Value limits"></span> |
| 8953 | ||
| 8954 | ||
| 8955 | </span> --> | |
| 8956 | </h2> | |
| 8957 | <div class="doc-row"> | |
| 8958 | <div class="doc-copy"> | |
| 8959 | <section class="json-schema-properties"> | |
| 8960 | <dl> | |
| 8961 | <dt data-property-name="name"> | |
| 8962 | <span class="json-property-name">name:</span> | |
| 8963 | <span class="json-property-type">string</span> | |
| 8964 | <span class="json-property-range" title="Value limits"></span> | |
| 8965 | </dt> | |
| 8966 | <dt data-property-name="description"> | |
| 8967 | <span class="json-property-name">description:</span> | |
| 8968 | <span class="json-property-type">string</span> | |
| 8969 | <span class="json-property-range" title="Value limits"></span> | |
| 8970 | </dt> | |
| 8971 | </dl> | |
| 8972 | </section> | |
| 8973 | </div> | |
| 8974 | <div class="doc-examples"> | |
| 8975 | <section> | |
| 8976 | <h5>Example</h5> | |
| 8977 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | |
| 8978 | <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, | |
| 8979 | <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span> | |
| 8980 | } | |
| 8981 | </code></pre> | |
| 8982 | <!-- </div> --> | |
| 8983 | </section> | |
| 8984 | </div> | |
| 8985 | </div> | |
| 8986 | </div> | |
| 8987 | <div class="doc-row no-margin"> | |
| 8988 | <div class="doc-copy doc-separator"> | |
| 8989 | <a class="powered-by" href="https://sourcey.com/spectacle">Documentation by | |
| 8990 | <span>Spectacle</span> | |
| 8991 | </a> | |
| 8992 | </div> | |
| 8993 | </div> | |
| 8994 | </article> | |
| 8995 | </div> | |
| 8996 | </div> | |
| 8997 | </body> | |
| 8998 | </html> |