aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api/html/index.html
diff options
context:
space:
mode:
Diffstat (limited to 'support/doc/api/html/index.html')
-rw-r--r--support/doc/api/html/index.html262
1 files changed, 247 insertions, 15 deletions
diff --git a/support/doc/api/html/index.html b/support/doc/api/html/index.html
index d41fc3913..b75a2a8ba 100644
--- a/support/doc/api/html/index.html
+++ b/support/doc/api/html/index.html
@@ -25,10 +25,10 @@
25 <a href="#tag-Accounts">Accounts</a> 25 <a href="#tag-Accounts">Accounts</a>
26 <ul> 26 <ul>
27 <li> 27 <li>
28 <a href="#operation--accounts--id--get"> GET /accounts/{id} </a> 28 <a href="#operation--accounts--name--get"> GET /accounts/{name} </a>
29 </li> 29 </li>
30 <li> 30 <li>
31 <a href="#operation--accounts--id--videos-get"> GET /accounts/{id}/videos </a> 31 <a href="#operation--accounts--name--videos-get"> GET /accounts/{name}/videos </a>
32 </li> 32 </li>
33 <li> 33 <li>
34 <a href="#operation--accounts-get"> GET /accounts </a> 34 <a href="#operation--accounts-get"> GET /accounts </a>
@@ -205,7 +205,7 @@
205 <a href="#operation--video-channels--id--videos-get"> GET /video-channels/{id}/videos </a> 205 <a href="#operation--video-channels--id--videos-get"> GET /video-channels/{id}/videos </a>
206 </li> 206 </li>
207 <li> 207 <li>
208 <a href="#operation--accounts--accountId--video-channels-get"> GET /accounts/{accountId}/video-channels </a> 208 <a href="#operation--accounts--name--video-channels-get"> GET /accounts/{name}/video-channels </a>
209 </li> 209 </li>
210 </ul> 210 </ul>
211 </section> 211 </section>
@@ -333,7 +333,7 @@
333 </div> 333 </div>
334 </div> 334 </div>
335 <h1 id="tag-Accounts" class="swagger-summary-tag" data-traverse-target="tag-Accounts">Accounts</h1> 335 <h1 id="tag-Accounts" class="swagger-summary-tag" data-traverse-target="tag-Accounts">Accounts</h1>
336 <div id="operation--accounts--id--get" class="operation panel" data-traverse-target="operation--accounts--id--get"> 336 <div id="operation--accounts--name--get" class="operation panel" data-traverse-target="operation--accounts--name--get">
337 <!-- <section class="operation-tags row"> --> 337 <!-- <section class="operation-tags row"> -->
338 <!-- <div class="doc-copy"> --> 338 <!-- <div class="doc-copy"> -->
339 <div class="operation-tags"> 339 <div class="operation-tags">
@@ -345,7 +345,7 @@
345 <h2 class="operation-title"> 345 <h2 class="operation-title">
346 <span class="operation-name"> 346 <span class="operation-name">
347 <span class="operation-name">GET</span> 347 <span class="operation-name">GET</span>
348 <span class="operation-path">/accounts/{id}</span> 348 <span class="operation-path">/accounts/{name}</span>
349 </span> 349 </span>
350 </h2> 350 </h2>
351 <div class="doc-row"> 351 <div class="doc-row">
@@ -353,7 +353,7 @@
353 <section class="swagger-request-params"> 353 <section class="swagger-request-params">
354 <div class="prop-row prop-group"> 354 <div class="prop-row prop-group">
355 <div class="prop-name"> 355 <div class="prop-name">
356 <div class="prop-title">id</div> 356 <div class="prop-title">name</div>
357 <span class="json-property-required"></span> 357 <span class="json-property-required"></span>
358 <div class="prop-subtitle"> in path </div> 358 <div class="prop-subtitle"> in path </div>
359 <div class="prop-subtitle"> 359 <div class="prop-subtitle">
@@ -362,7 +362,8 @@
362 </div> 362 </div>
363 </div> 363 </div>
364 <div class="prop-value"> 364 <div class="prop-value">
365 <p>The id of the account</p> 365 <p>The name of the account (chocobozzz or
366 <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p>
366 </div> 367 </div>
367 </div> 368 </div>
368 <div class="prop-row prop-group"> 369 <div class="prop-row prop-group">
@@ -458,7 +459,7 @@
458 </div> 459 </div>
459 </div> 460 </div>
460 </div> 461 </div>
461 <div id="operation--accounts--id--videos-get" class="operation panel" data-traverse-target="operation--accounts--id--videos-get"> 462 <div id="operation--accounts--name--videos-get" class="operation panel" data-traverse-target="operation--accounts--name--videos-get">
462 <!-- <section class="operation-tags row"> --> 463 <!-- <section class="operation-tags row"> -->
463 <!-- <div class="doc-copy"> --> 464 <!-- <div class="doc-copy"> -->
464 <div class="operation-tags"> 465 <div class="operation-tags">
@@ -470,7 +471,7 @@
470 <h2 class="operation-title"> 471 <h2 class="operation-title">
471 <span class="operation-name"> 472 <span class="operation-name">
472 <span class="operation-name">GET</span> 473 <span class="operation-name">GET</span>
473 <span class="operation-path">/accounts/{id}/videos</span> 474 <span class="operation-path">/accounts/{name}/videos</span>
474 </span> 475 </span>
475 </h2> 476 </h2>
476 <div class="doc-row"> 477 <div class="doc-row">
@@ -478,7 +479,7 @@
478 <section class="swagger-request-params"> 479 <section class="swagger-request-params">
479 <div class="prop-row prop-group"> 480 <div class="prop-row prop-group">
480 <div class="prop-name"> 481 <div class="prop-name">
481 <div class="prop-title">id</div> 482 <div class="prop-title">name</div>
482 <span class="json-property-required"></span> 483 <span class="json-property-required"></span>
483 <div class="prop-subtitle"> in path </div> 484 <div class="prop-subtitle"> in path </div>
484 <div class="prop-subtitle"> 485 <div class="prop-subtitle">
@@ -487,7 +488,8 @@
487 </div> 488 </div>
488 </div> 489 </div>
489 <div class="prop-value"> 490 <div class="prop-value">
490 <p>The id of the account</p> 491 <p>The name of the account (chocobozzz or
492 <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p>
491 </div> 493 </div>
492 </div> 494 </div>
493 </section> 495 </section>
@@ -5329,7 +5331,7 @@
5329 </div> 5331 </div>
5330 </div> 5332 </div>
5331 </div> 5333 </div>
5332 <div id="operation--accounts--accountId--video-channels-get" class="operation panel" data-traverse-target="operation--accounts--accountId--video-channels-get"> 5334 <div id="operation--accounts--name--video-channels-get" class="operation panel" data-traverse-target="operation--accounts--name--video-channels-get">
5333 <!-- <section class="operation-tags row"> --> 5335 <!-- <section class="operation-tags row"> -->
5334 <!-- <div class="doc-copy"> --> 5336 <!-- <div class="doc-copy"> -->
5335 <div class="operation-tags"> 5337 <div class="operation-tags">
@@ -5341,7 +5343,7 @@
5341 <h2 class="operation-title"> 5343 <h2 class="operation-title">
5342 <span class="operation-name"> 5344 <span class="operation-name">
5343 <span class="operation-name">GET</span> 5345 <span class="operation-name">GET</span>
5344 <span class="operation-path">/accounts/{accountId}/video-channels</span> 5346 <span class="operation-path">/accounts/{name}/video-channels</span>
5345 </span> 5347 </span>
5346 </h2> 5348 </h2>
5347 <div class="doc-row"> 5349 <div class="doc-row">
@@ -5349,7 +5351,7 @@
5349 <section class="swagger-request-params"> 5351 <section class="swagger-request-params">
5350 <div class="prop-row prop-group"> 5352 <div class="prop-row prop-group">
5351 <div class="prop-name"> 5353 <div class="prop-name">
5352 <div class="prop-title">accountId</div> 5354 <div class="prop-title">name</div>
5353 <span class="json-property-required"></span> 5355 <span class="json-property-required"></span>
5354 <div class="prop-subtitle"> in path </div> 5356 <div class="prop-subtitle"> in path </div>
5355 <div class="prop-subtitle"> 5357 <div class="prop-subtitle">
@@ -5358,7 +5360,8 @@
5358 </div> 5360 </div>
5359 </div> 5361 </div>
5360 <div class="prop-value"> 5362 <div class="prop-value">
5361 <p>The account id </p> 5363 <p>The name of the account (chocobozzz or
5364 <a href="mailto:chocobozzz@peertube.cpy.re">chocobozzz@peertube.cpy.re</a> for example)</p>
5362 </div> 5365 </div>
5363 </div> 5366 </div>
5364 </section> 5367 </section>
@@ -6403,6 +6406,41 @@
6403 <span class="json-property-type">object</span> 6406 <span class="json-property-type">object</span>
6404 <span class="json-property-range" title="Value limits"></span> 6407 <span class="json-property-range" title="Value limits"></span>
6405 </dt> 6408 </dt>
6409 <dt class="json-inner-schema">
6410 <section class="json-schema-properties">
6411 <dl>
6412 <dt data-property-name="name">
6413 <span class="json-property-name">name:</span>
6414 <span class="json-property-type">string</span>
6415 <span class="json-property-range" title="Value limits"></span>
6416 </dt>
6417 <dt data-property-name="displayName">
6418 <span class="json-property-name">displayName:</span>
6419 <span class="json-property-type">string</span>
6420 <span class="json-property-range" title="Value limits"></span>
6421 </dt>
6422 <dt data-property-name="url">
6423 <span class="json-property-name">url:</span>
6424 <span class="json-property-type">string</span>
6425 <span class="json-property-range" title="Value limits"></span>
6426 </dt>
6427 <dt data-property-name="host">
6428 <span class="json-property-name">host:</span>
6429 <span class="json-property-type">string</span>
6430 <span class="json-property-range" title="Value limits"></span>
6431 </dt>
6432 <dt data-property-name="avatar">
6433 <span class="json-property-name">avatar:</span>
6434 <span class="json-property-type">
6435 <span class="">
6436 <a class="json-schema-ref" href="#/definitions/Avatar">Avatar</a>
6437 </span>
6438 </span>
6439 <span class="json-property-range" title="Value limits"></span>
6440 </dt>
6441 </dl>
6442 </section>
6443 </dt>
6406 </dl> 6444 </dl>
6407 </section> 6445 </section>
6408 </div> 6446 </div>
@@ -6494,6 +6532,32 @@
6494 <span class="json-property-type">object</span> 6532 <span class="json-property-type">object</span>
6495 <span class="json-property-range" title="Value limits"></span> 6533 <span class="json-property-range" title="Value limits"></span>
6496 </dt> 6534 </dt>
6535 <dt class="json-inner-schema">
6536 <section class="json-schema-properties">
6537 <dl>
6538 <dt data-property-name="id">
6539 <span class="json-property-name">id:</span>
6540 <span class="json-property-type">number</span>
6541 <span class="json-property-range" title="Value limits"></span>
6542 </dt>
6543 <dt data-property-name="name">
6544 <span class="json-property-name">name:</span>
6545 <span class="json-property-type">string</span>
6546 <span class="json-property-range" title="Value limits"></span>
6547 </dt>
6548 <dt data-property-name="uuid">
6549 <span class="json-property-name">uuid:</span>
6550 <span class="json-property-type">string</span>
6551 <span class="json-property-range" title="Value limits"></span>
6552 </dt>
6553 <dt data-property-name="url">
6554 <span class="json-property-name">url:</span>
6555 <span class="json-property-type">string</span>
6556 <span class="json-property-range" title="Value limits"></span>
6557 </dt>
6558 </dl>
6559 </section>
6560 </dt>
6497 <dt data-property-name="createdAt"> 6561 <dt data-property-name="createdAt">
6498 <span class="json-property-name">createdAt:</span> 6562 <span class="json-property-name">createdAt:</span>
6499 <span class="json-property-type">string</span> 6563 <span class="json-property-type">string</span>
@@ -6671,6 +6735,22 @@
6671 <span class="json-property-type">object</span> 6735 <span class="json-property-type">object</span>
6672 <span class="json-property-range" title="Value limits"></span> 6736 <span class="json-property-range" title="Value limits"></span>
6673 </dt> 6737 </dt>
6738 <dt class="json-inner-schema">
6739 <section class="json-schema-properties">
6740 <dl>
6741 <dt data-property-name="id">
6742 <span class="json-property-name">id:</span>
6743 <span class="json-property-type">number</span>
6744 <span class="json-property-range" title="Value limits"></span>
6745 </dt>
6746 <dt data-property-name="uuid">
6747 <span class="json-property-name">uuid:</span>
6748 <span class="json-property-type">string</span>
6749 <span class="json-property-range" title="Value limits"></span>
6750 </dt>
6751 </dl>
6752 </section>
6753 </dt>
6674 </dl> 6754 </dl>
6675 </section> 6755 </section>
6676 </div> 6756 </div>
@@ -6830,6 +6910,17 @@
6830 </span> 6910 </span>
6831 <span class="json-property-range" title="Value limits"></span> 6911 <span class="json-property-range" title="Value limits"></span>
6832 </dt> 6912 </dt>
6913 <dt class="json-inner-schema">
6914 <section class="json-schema-array-items">
6915 <span class="json-property-type">
6916 <span class="">
6917 <a class="json-schema-ref" href="#/definitions/VideoCommentThreadTree">VideoCommentThreadTree</a>
6918 </span>
6919 </span>
6920 <span class="json-property-range" title="Value limits"></span>
6921 <div class="json-inner-schema"> </div>
6922 </section>
6923 </dt>
6833 </dl> 6924 </dl>
6834 </section> 6925 </section>
6835 </div> 6926 </div>
@@ -7210,6 +7301,17 @@
7210 </span> 7301 </span>
7211 <span class="json-property-range" title="Value limits"></span> 7302 <span class="json-property-range" title="Value limits"></span>
7212 </dt> 7303 </dt>
7304 <dt class="json-inner-schema">
7305 <section class="json-schema-array-items">
7306 <span class="json-property-type">
7307 <span class="">
7308 <a class="json-schema-ref" href="#/definitions/VideoChannel">VideoChannel</a>
7309 </span>
7310 </span>
7311 <span class="json-property-range" title="Value limits"></span>
7312 <div class="json-inner-schema"> </div>
7313 </section>
7314 </dt>
7213 </dl> 7315 </dl>
7214 </section> 7316 </section>
7215 </div> 7317 </div>
@@ -7278,21 +7380,124 @@
7278 <span class="json-property-type">object</span> 7380 <span class="json-property-type">object</span>
7279 <span class="json-property-range" title="Value limits"></span> 7381 <span class="json-property-range" title="Value limits"></span>
7280 </dt> 7382 </dt>
7383 <dt class="json-inner-schema">
7384 <section class="json-schema-properties">
7385 <dl>
7386 <dt data-property-name="allowed">
7387 <span class="json-property-name">allowed:</span>
7388 <span class="json-property-type">boolean</span>
7389 <span class="json-property-range" title="Value limits"></span>
7390 </dt>
7391 </dl>
7392 </section>
7393 </dt>
7281 <dt data-property-name="transcoding"> 7394 <dt data-property-name="transcoding">
7282 <span class="json-property-name">transcoding:</span> 7395 <span class="json-property-name">transcoding:</span>
7283 <span class="json-property-type">object</span> 7396 <span class="json-property-type">object</span>
7284 <span class="json-property-range" title="Value limits"></span> 7397 <span class="json-property-range" title="Value limits"></span>
7285 </dt> 7398 </dt>
7399 <dt class="json-inner-schema">
7400 <section class="json-schema-properties">
7401 <dl>
7402 <dt data-property-name="enabledResolutions">
7403 <span class="json-property-name">enabledResolutions:</span>
7404 <span class="json-property-type">number[]</span>
7405 <span class="json-property-range" title="Value limits"></span>
7406 </dt>
7407 <dt class="json-inner-schema">
7408 <section class="json-schema-array-items">
7409 <span class="json-property-type">number</span>
7410 <span class="json-property-range" title="Value limits"></span>
7411 <div class="json-inner-schema"> </div>
7412 </section>
7413 </dt>
7414 </dl>
7415 </section>
7416 </dt>
7286 <dt data-property-name="avatar"> 7417 <dt data-property-name="avatar">
7287 <span class="json-property-name">avatar:</span> 7418 <span class="json-property-name">avatar:</span>
7288 <span class="json-property-type">object</span> 7419 <span class="json-property-type">object</span>
7289 <span class="json-property-range" title="Value limits"></span> 7420 <span class="json-property-range" title="Value limits"></span>
7290 </dt> 7421 </dt>
7422 <dt class="json-inner-schema">
7423 <section class="json-schema-properties">
7424 <dl>
7425 <dt data-property-name="file">
7426 <span class="json-property-name">file:</span>
7427 <span class="json-property-type">object</span>
7428 <span class="json-property-range" title="Value limits"></span>
7429 </dt>
7430 <dt class="json-inner-schema">
7431 <section class="json-schema-properties">
7432 <dl>
7433 <dt data-property-name="size">
7434 <span class="json-property-name">size:</span>
7435 <span class="json-property-type">object</span>
7436 <span class="json-property-range" title="Value limits"></span>
7437 </dt>
7438 <dt class="json-inner-schema">
7439 <section class="json-schema-properties">
7440 <dl>
7441 <dt data-property-name="max">
7442 <span class="json-property-name">max:</span>
7443 <span class="json-property-type">number</span>
7444 <span class="json-property-range" title="Value limits"></span>
7445 </dt>
7446 </dl>
7447 </section>
7448 </dt>
7449 </dl>
7450 </section>
7451 </dt>
7452 <dt data-property-name="extensions">
7453 <span class="json-property-name">extensions:</span>
7454 <span class="json-property-type">string[]</span>
7455 <span class="json-property-range" title="Value limits"></span>
7456 </dt>
7457 <dt class="json-inner-schema">
7458 <section class="json-schema-array-items">
7459 <span class="json-property-type">string</span>
7460 <span class="json-property-range" title="Value limits"></span>
7461 <div class="json-inner-schema"> </div>
7462 </section>
7463 </dt>
7464 </dl>
7465 </section>
7466 </dt>
7291 <dt data-property-name="video"> 7467 <dt data-property-name="video">
7292 <span class="json-property-name">video:</span> 7468 <span class="json-property-name">video:</span>
7293 <span class="json-property-type">object</span> 7469 <span class="json-property-type">object</span>
7294 <span class="json-property-range" title="Value limits"></span> 7470 <span class="json-property-range" title="Value limits"></span>
7295 </dt> 7471 </dt>
7472 <dt class="json-inner-schema">
7473 <section class="json-schema-properties">
7474 <dl>
7475 <dt data-property-name="file">
7476 <span class="json-property-name">file:</span>
7477 <span class="json-property-type">object</span>
7478 <span class="json-property-range" title="Value limits"></span>
7479 </dt>
7480 <dt class="json-inner-schema">
7481 <section class="json-schema-properties">
7482 <dl>
7483 <dt data-property-name="extensions">
7484 <span class="json-property-name">extensions:</span>
7485 <span class="json-property-type">string[]</span>
7486 <span class="json-property-range" title="Value limits"></span>
7487 </dt>
7488 <dt class="json-inner-schema">
7489 <section class="json-schema-array-items">
7490 <span class="json-property-type">string</span>
7491 <span class="json-property-range" title="Value limits"></span>
7492 <div class="json-inner-schema"> </div>
7493 </section>
7494 </dt>
7495 </dl>
7496 </section>
7497 </dt>
7498 </dl>
7499 </section>
7500 </dt>
7296 </dl> 7501 </dl>
7297 </section> 7502 </section>
7298 </div> 7503 </div>
@@ -7579,6 +7784,22 @@
7579 <span class="json-property-type">object</span> 7784 <span class="json-property-type">object</span>
7580 <span class="json-property-range" title="Value limits"></span> 7785 <span class="json-property-range" title="Value limits"></span>
7581 </dt> 7786 </dt>
7787 <dt class="json-inner-schema">
7788 <section class="json-schema-properties">
7789 <dl>
7790 <dt data-property-name="id">
7791 <span class="json-property-name">id:</span>
7792 <span class="json-property-type">number</span>
7793 <span class="json-property-range" title="Value limits"></span>
7794 </dt>
7795 <dt data-property-name="uuid">
7796 <span class="json-property-name">uuid:</span>
7797 <span class="json-property-type">string</span>
7798 <span class="json-property-range" title="Value limits"></span>
7799 </dt>
7800 </dl>
7801 </section>
7802 </dt>
7582 </dl> 7803 </dl>
7583 </section> 7804 </section>
7584 </div> 7805 </div>
@@ -7624,6 +7845,17 @@
7624 </span> 7845 </span>
7625 <span class="json-property-range" title="Value limits"></span> 7846 <span class="json-property-range" title="Value limits"></span>
7626 </dt> 7847 </dt>
7848 <dt class="json-inner-schema">
7849 <section class="json-schema-array-items">
7850 <span class="json-property-type">
7851 <span class="">
7852 <a class="json-schema-ref" href="#/definitions/VideoComment">VideoComment</a>
7853 </span>
7854 </span>
7855 <span class="json-property-range" title="Value limits"></span>
7856 <div class="json-inner-schema"> </div>
7857 </section>
7858 </dt>
7627 </dl> 7859 </dl>
7628 </section> 7860 </section>
7629 </div> 7861 </div>
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-13 22:09:37 +0000