diff options
Diffstat (limited to 'support/doc')
-rw-r--r-- | support/doc/api/openapi.yaml | 169 |
1 files changed, 158 insertions, 11 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 3a3e71f93..b83362a37 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -433,7 +433,7 @@ paths: | |||
433 | parameters: | 433 | parameters: |
434 | - $ref: '#/components/parameters/start' | 434 | - $ref: '#/components/parameters/start' |
435 | - $ref: '#/components/parameters/count' | 435 | - $ref: '#/components/parameters/count' |
436 | - $ref: '#/components/parameters/sort' | 436 | - $ref: '#/components/parameters/usersSort' |
437 | responses: | 437 | responses: |
438 | '200': | 438 | '200': |
439 | description: successful operation | 439 | description: successful operation |
@@ -622,15 +622,16 @@ paths: | |||
622 | tags: | 622 | tags: |
623 | - Video | 623 | - Video |
624 | parameters: | 624 | parameters: |
625 | - name: category | 625 | - $ref: '#/components/parameters/categoryOneOf' |
626 | in: query | 626 | - $ref: '#/components/parameters/tagsOneOf' |
627 | required: false | 627 | - $ref: '#/components/parameters/tagsAllOf' |
628 | description: category id of the video | 628 | - $ref: '#/components/parameters/licenceOneOf' |
629 | schema: | 629 | - $ref: '#/components/parameters/languageOneOf' |
630 | type: number | 630 | - $ref: '#/components/parameters/nsfw' |
631 | - $ref: '#/components/parameters/filter' | ||
631 | - $ref: '#/components/parameters/start' | 632 | - $ref: '#/components/parameters/start' |
632 | - $ref: '#/components/parameters/count' | 633 | - $ref: '#/components/parameters/count' |
633 | - $ref: '#/components/parameters/sort' | 634 | - $ref: '#/components/parameters/videosSort' |
634 | responses: | 635 | responses: |
635 | '200': | 636 | '200': |
636 | description: successful operation | 637 | description: successful operation |
@@ -1002,7 +1003,7 @@ paths: | |||
1002 | parameters: | 1003 | parameters: |
1003 | - $ref: '#/components/parameters/start' | 1004 | - $ref: '#/components/parameters/start' |
1004 | - $ref: '#/components/parameters/count' | 1005 | - $ref: '#/components/parameters/count' |
1005 | - $ref: '#/components/parameters/sort' | 1006 | - $ref: '#/components/parameters/abusesSort' |
1006 | responses: | 1007 | responses: |
1007 | '200': | 1008 | '200': |
1008 | description: successful operation | 1009 | description: successful operation |
@@ -1063,7 +1064,7 @@ paths: | |||
1063 | parameters: | 1064 | parameters: |
1064 | - $ref: '#/components/parameters/start' | 1065 | - $ref: '#/components/parameters/start' |
1065 | - $ref: '#/components/parameters/count' | 1066 | - $ref: '#/components/parameters/count' |
1066 | - $ref: '#/components/parameters/sort' | 1067 | - $ref: '#/components/parameters/blacklistsSort' |
1067 | responses: | 1068 | responses: |
1068 | '200': | 1069 | '200': |
1069 | description: successful operation | 1070 | description: successful operation |
@@ -1271,7 +1272,7 @@ paths: | |||
1271 | parameters: | 1272 | parameters: |
1272 | - $ref: '#/components/parameters/start' | 1273 | - $ref: '#/components/parameters/start' |
1273 | - $ref: '#/components/parameters/count' | 1274 | - $ref: '#/components/parameters/count' |
1274 | - $ref: '#/components/parameters/sort' | 1275 | - $ref: '#/components/parameters/videosSearchSort' |
1275 | - name: search | 1276 | - name: search |
1276 | in: query | 1277 | in: query |
1277 | required: true | 1278 | required: true |
@@ -1317,6 +1318,74 @@ components: | |||
1317 | description: Sort column (-createdAt for example) | 1318 | description: Sort column (-createdAt for example) |
1318 | schema: | 1319 | schema: |
1319 | type: string | 1320 | type: string |
1321 | videosSort: | ||
1322 | name: sort | ||
1323 | in: query | ||
1324 | required: false | ||
1325 | description: Sort videos by criteria | ||
1326 | schema: | ||
1327 | type: string | ||
1328 | enum: | ||
1329 | - -name | ||
1330 | - -duration | ||
1331 | - -createdAt | ||
1332 | - -publishedAt | ||
1333 | - -views | ||
1334 | - -likes | ||
1335 | - -trending | ||
1336 | videosSearchSort: | ||
1337 | name: sort | ||
1338 | in: query | ||
1339 | required: false | ||
1340 | description: Sort videos by criteria | ||
1341 | schema: | ||
1342 | type: string | ||
1343 | enum: | ||
1344 | - -name | ||
1345 | - -duration | ||
1346 | - -createdAt | ||
1347 | - -publishedAt | ||
1348 | - -views | ||
1349 | - -likes | ||
1350 | - -match | ||
1351 | blacklistsSort: | ||
1352 | name: sort | ||
1353 | in: query | ||
1354 | required: false | ||
1355 | description: Sort blacklists by criteria | ||
1356 | schema: | ||
1357 | type: string | ||
1358 | enum: | ||
1359 | - -id | ||
1360 | - -name | ||
1361 | - -duration | ||
1362 | - -views | ||
1363 | - -likes | ||
1364 | - -dislikes | ||
1365 | - -uuid | ||
1366 | - -createdAt | ||
1367 | usersSort: | ||
1368 | name: sort | ||
1369 | in: query | ||
1370 | required: false | ||
1371 | description: Sort users by criteria | ||
1372 | schema: | ||
1373 | type: string | ||
1374 | enum: | ||
1375 | - -id | ||
1376 | - -username | ||
1377 | - -createdAt | ||
1378 | abusesSort: | ||
1379 | name: sort | ||
1380 | in: query | ||
1381 | required: false | ||
1382 | description: Sort abuses by criteria | ||
1383 | schema: | ||
1384 | type: string | ||
1385 | enum: | ||
1386 | - -id | ||
1387 | - -createdAt | ||
1388 | - -state | ||
1320 | name: | 1389 | name: |
1321 | name: name | 1390 | name: name |
1322 | in: path | 1391 | in: path |
@@ -1354,6 +1423,84 @@ components: | |||
1354 | description: The comment id | 1423 | description: The comment id |
1355 | schema: | 1424 | schema: |
1356 | type: number | 1425 | type: number |
1426 | categoryOneOf: | ||
1427 | name: categoryOneOf | ||
1428 | in: query | ||
1429 | required: false | ||
1430 | description: category id of the video | ||
1431 | schema: | ||
1432 | oneOf: | ||
1433 | - type: number | ||
1434 | - type: array | ||
1435 | items: | ||
1436 | type: number | ||
1437 | tagsOneOf: | ||
1438 | name: tagsOneOf | ||
1439 | in: query | ||
1440 | required: false | ||
1441 | description: tag(s) of the video | ||
1442 | schema: | ||
1443 | oneOf: | ||
1444 | - type: string | ||
1445 | - type: array | ||
1446 | items: | ||
1447 | type: string | ||
1448 | tagsAllOf: | ||
1449 | name: tagsAllOf | ||
1450 | in: query | ||
1451 | required: false | ||
1452 | description: tag(s) of the video, where all should be present in the video | ||
1453 | schema: | ||
1454 | oneOf: | ||
1455 | - type: string | ||
1456 | - type: array | ||
1457 | items: | ||
1458 | type: string | ||
1459 | languageOneOf: | ||
1460 | name: languageOneOf | ||
1461 | in: query | ||
1462 | required: false | ||
1463 | description: language id of the video | ||
1464 | schema: | ||
1465 | oneOf: | ||
1466 | - type: number | ||
1467 | - type: array | ||
1468 | items: | ||
1469 | type: number | ||
1470 | licenceOneOf: | ||
1471 | name: licenceOneOf | ||
1472 | in: query | ||
1473 | required: false | ||
1474 | description: licence id of the video | ||
1475 | schema: | ||
1476 | oneOf: | ||
1477 | - type: number | ||
1478 | - type: array | ||
1479 | items: | ||
1480 | type: number | ||
1481 | nsfw: | ||
1482 | name: nsfw | ||
1483 | in: query | ||
1484 | required: false | ||
1485 | description: whether to include nsfw videos, if any | ||
1486 | schema: | ||
1487 | type: string | ||
1488 | enum: | ||
1489 | - 'true' | ||
1490 | - 'false' | ||
1491 | filter: | ||
1492 | name: filter | ||
1493 | in: query | ||
1494 | required: false | ||
1495 | description: > | ||
1496 | Special filters (local for instance) which might require special rights: | ||
1497 | * `local` - only videos local to the instance | ||
1498 | * `all-local` - only videos local to the instance, but showing private and unlisted videos (requires Admin privileges) | ||
1499 | schema: | ||
1500 | type: string | ||
1501 | enum: | ||
1502 | - local | ||
1503 | - all-local | ||
1357 | requestBodies: | 1504 | requestBodies: |
1358 | VideoChannelInput: | 1505 | VideoChannelInput: |
1359 | content: | 1506 | content: |