aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api
diff options
context:
space:
mode:
Diffstat (limited to 'support/doc/api')
-rw-r--r--support/doc/api/openapi.yaml76
1 files changed, 44 insertions, 32 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 0dc50e403..7bcad1692 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -638,7 +638,7 @@ paths:
638 application/json: 638 application/json:
639 schema: 639 schema:
640 $ref: '#/components/schemas/VideoListResponse' 640 $ref: '#/components/schemas/VideoListResponse'
641 '/users/me/subscriptions/{uri}': 641 '/users/me/subscriptions/{subscriptionHandle}':
642 get: 642 get:
643 summary: Get subscription of the current user for a given uri 643 summary: Get subscription of the current user for a given uri
644 security: 644 security:
@@ -646,6 +646,8 @@ paths:
646 - user 646 - user
647 tags: 647 tags:
648 - User 648 - User
649 parameters:
650 - $ref: '#/components/parameters/subscriptionHandle'
649 responses: 651 responses:
650 '200': 652 '200':
651 description: successful operation 653 description: successful operation
@@ -660,6 +662,8 @@ paths:
660 - user 662 - user
661 tags: 663 tags:
662 - User 664 - User
665 parameters:
666 - $ref: '#/components/parameters/subscriptionHandle'
663 responses: 667 responses:
664 '200': 668 '200':
665 description: successful operation 669 description: successful operation
@@ -792,7 +796,7 @@ paths:
792 tags: 796 tags:
793 - Video 797 - Video
794 parameters: 798 parameters:
795 - $ref: '#/components/parameters/id2' 799 - $ref: '#/components/parameters/idOrUUID'
796 responses: 800 responses:
797 '200': 801 '200':
798 description: successful operation 802 description: successful operation
@@ -851,7 +855,7 @@ paths:
851 tags: 855 tags:
852 - Video 856 - Video
853 parameters: 857 parameters:
854 - $ref: '#/components/parameters/id2' 858 - $ref: '#/components/parameters/idOrUUID'
855 responses: 859 responses:
856 '200': 860 '200':
857 description: successful operation 861 description: successful operation
@@ -866,7 +870,7 @@ paths:
866 tags: 870 tags:
867 - Video 871 - Video
868 parameters: 872 parameters:
869 - $ref: '#/components/parameters/id2' 873 - $ref: '#/components/parameters/idOrUUID'
870 responses: 874 responses:
871 '204': 875 '204':
872 $ref: '#/paths/~1users~1me/put/responses/204' 876 $ref: '#/paths/~1users~1me/put/responses/204'
@@ -876,7 +880,7 @@ paths:
876 tags: 880 tags:
877 - Video 881 - Video
878 parameters: 882 parameters:
879 - $ref: '#/components/parameters/id2' 883 - $ref: '#/components/parameters/idOrUUID'
880 responses: 884 responses:
881 '200': 885 '200':
882 description: successful operation 886 description: successful operation
@@ -890,7 +894,7 @@ paths:
890 tags: 894 tags:
891 - Video 895 - Video
892 parameters: 896 parameters:
893 - $ref: '#/components/parameters/id2' 897 - $ref: '#/components/parameters/idOrUUID'
894 responses: 898 responses:
895 '204': 899 '204':
896 $ref: '#/paths/~1users~1me/put/responses/204' 900 $ref: '#/paths/~1users~1me/put/responses/204'
@@ -902,7 +906,7 @@ paths:
902 security: 906 security:
903 - OAuth2: [] 907 - OAuth2: []
904 parameters: 908 parameters:
905 - $ref: '#/components/parameters/id2' 909 - $ref: '#/components/parameters/idOrUUID'
906 requestBody: 910 requestBody:
907 content: 911 content:
908 application/json: 912 application/json:
@@ -919,8 +923,6 @@ paths:
919 - Video 923 - Video
920 security: 924 security:
921 - OAuth2: [] 925 - OAuth2: []
922 parameters:
923 - $ref: '#/components/parameters/id2'
924 responses: 926 responses:
925 '200': 927 '200':
926 description: successful operation 928 description: successful operation
@@ -932,7 +934,7 @@ paths:
932 security: 934 security:
933 - OAuth2: [] 935 - OAuth2: []
934 parameters: 936 parameters:
935 - $ref: '#/components/parameters/id2' 937 - $ref: '#/components/parameters/idOrUUID'
936 responses: 938 responses:
937 '204': 939 '204':
938 $ref: '#/paths/~1users~1me/put/responses/204' 940 $ref: '#/paths/~1users~1me/put/responses/204'
@@ -944,7 +946,7 @@ paths:
944 security: 946 security:
945 - OAuth2: [] 947 - OAuth2: []
946 parameters: 948 parameters:
947 - $ref: '#/components/parameters/id2' 949 - $ref: '#/components/parameters/idOrUUID'
948 responses: 950 responses:
949 '204': 951 '204':
950 $ref: '#/paths/~1users~1me/put/responses/204' 952 $ref: '#/paths/~1users~1me/put/responses/204'
@@ -956,7 +958,7 @@ paths:
956 security: 958 security:
957 - OAuth2: [] 959 - OAuth2: []
958 parameters: 960 parameters:
959 - $ref: '#/components/parameters/id2' 961 - $ref: '#/components/parameters/idOrUUID'
960 requestBody: 962 requestBody:
961 required: true 963 required: true
962 content: 964 content:
@@ -1178,7 +1180,7 @@ paths:
1178 tags: 1180 tags:
1179 - Video Abuse 1181 - Video Abuse
1180 parameters: 1182 parameters:
1181 - $ref: '#/components/parameters/id2' 1183 - $ref: '#/components/parameters/idOrUUID'
1182 responses: 1184 responses:
1183 '204': 1185 '204':
1184 $ref: '#/paths/~1users~1me/put/responses/204' 1186 $ref: '#/paths/~1users~1me/put/responses/204'
@@ -1192,7 +1194,7 @@ paths:
1192 tags: 1194 tags:
1193 - Video Blacklist 1195 - Video Blacklist
1194 parameters: 1196 parameters:
1195 - $ref: '#/components/parameters/id2' 1197 - $ref: '#/components/parameters/idOrUUID'
1196 responses: 1198 responses:
1197 '204': 1199 '204':
1198 $ref: '#/paths/~1users~1me/put/responses/204' 1200 $ref: '#/paths/~1users~1me/put/responses/204'
@@ -1205,7 +1207,7 @@ paths:
1205 tags: 1207 tags:
1206 - Video Blacklist 1208 - Video Blacklist
1207 parameters: 1209 parameters:
1208 - $ref: '#/components/parameters/id2' 1210 - $ref: '#/components/parameters/idOrUUID'
1209 responses: 1211 responses:
1210 '204': 1212 '204':
1211 $ref: '#/paths/~1users~1me/put/responses/204' 1213 $ref: '#/paths/~1users~1me/put/responses/204'
@@ -1237,7 +1239,7 @@ paths:
1237 tags: 1239 tags:
1238 - Video Caption 1240 - Video Caption
1239 parameters: 1241 parameters:
1240 - $ref: '#/components/parameters/id2' 1242 - $ref: '#/components/parameters/idOrUUID'
1241 responses: 1243 responses:
1242 '200': 1244 '200':
1243 description: successful operation 1245 description: successful operation
@@ -1258,7 +1260,7 @@ paths:
1258 tags: 1260 tags:
1259 - Video Caption 1261 - Video Caption
1260 parameters: 1262 parameters:
1261 - $ref: '#/components/parameters/id2' 1263 - $ref: '#/components/parameters/idOrUUID'
1262 - $ref: '#/components/parameters/captionLanguage' 1264 - $ref: '#/components/parameters/captionLanguage'
1263 requestBody: 1265 requestBody:
1264 content: 1266 content:
@@ -1278,7 +1280,7 @@ paths:
1278 tags: 1280 tags:
1279 - Video Caption 1281 - Video Caption
1280 parameters: 1282 parameters:
1281 - $ref: '#/components/parameters/id2' 1283 - $ref: '#/components/parameters/idOrUUID'
1282 - $ref: '#/components/parameters/captionLanguage' 1284 - $ref: '#/components/parameters/captionLanguage'
1283 responses: 1285 responses:
1284 '204': 1286 '204':
@@ -1395,6 +1397,7 @@ paths:
1395 tags: 1397 tags:
1396 - User 1398 - User
1397 parameters: 1399 parameters:
1400 - $ref: '#/components/parameters/name'
1398 - $ref: '#/components/parameters/start' 1401 - $ref: '#/components/parameters/start'
1399 - $ref: '#/components/parameters/count' 1402 - $ref: '#/components/parameters/count'
1400 - $ref: '#/components/parameters/sort' 1403 - $ref: '#/components/parameters/sort'
@@ -1422,7 +1425,7 @@ paths:
1422 tags: 1425 tags:
1423 - Video Comment 1426 - Video Comment
1424 parameters: 1427 parameters:
1425 - $ref: '#/components/parameters/id2' 1428 - $ref: '#/components/parameters/idOrUUID'
1426 - $ref: '#/components/parameters/start' 1429 - $ref: '#/components/parameters/start'
1427 - $ref: '#/components/parameters/count' 1430 - $ref: '#/components/parameters/count'
1428 - $ref: '#/components/parameters/sort' 1431 - $ref: '#/components/parameters/sort'
@@ -1440,7 +1443,7 @@ paths:
1440 tags: 1443 tags:
1441 - Video Comment 1444 - Video Comment
1442 parameters: 1445 parameters:
1443 - $ref: '#/components/parameters/id2' 1446 - $ref: '#/components/parameters/idOrUUID'
1444 responses: 1447 responses:
1445 '200': 1448 '200':
1446 description: successful operation 1449 description: successful operation
@@ -1454,13 +1457,8 @@ paths:
1454 tags: 1457 tags:
1455 - Video Comment 1458 - Video Comment
1456 parameters: 1459 parameters:
1457 - $ref: '#/components/parameters/id2' 1460 - $ref: '#/components/parameters/idOrUUID'
1458 - name: threadId 1461 - $ref: '#/components/parameters/threadId'
1459 in: path
1460 required: true
1461 description: The thread id (root comment id)
1462 schema:
1463 type: number
1464 responses: 1462 responses:
1465 '200': 1463 '200':
1466 description: successful operation 1464 description: successful operation
@@ -1476,7 +1474,7 @@ paths:
1476 tags: 1474 tags:
1477 - Video Comment 1475 - Video Comment
1478 parameters: 1476 parameters:
1479 - $ref: '#/components/parameters/id2' 1477 - $ref: '#/components/parameters/idOrUUID'
1480 - $ref: '#/components/parameters/commentId' 1478 - $ref: '#/components/parameters/commentId'
1481 responses: 1479 responses:
1482 '200': 1480 '200':
@@ -1492,7 +1490,7 @@ paths:
1492 tags: 1490 tags:
1493 - Video Comment 1491 - Video Comment
1494 parameters: 1492 parameters:
1495 - $ref: '#/components/parameters/id2' 1493 - $ref: '#/components/parameters/idOrUUID'
1496 - $ref: '#/components/parameters/commentId' 1494 - $ref: '#/components/parameters/commentId'
1497 responses: 1495 responses:
1498 '204': 1496 '204':
@@ -1505,7 +1503,7 @@ paths:
1505 tags: 1503 tags:
1506 - Video Rate 1504 - Video Rate
1507 parameters: 1505 parameters:
1508 - $ref: '#/components/parameters/id2' 1506 - $ref: '#/components/parameters/idOrUUID'
1509 responses: 1507 responses:
1510 '204': 1508 '204':
1511 $ref: '#/paths/~1users~1me/put/responses/204' 1509 $ref: '#/paths/~1users~1me/put/responses/204'
@@ -1645,7 +1643,7 @@ components:
1645 description: The user id 1643 description: The user id
1646 schema: 1644 schema:
1647 type: number 1645 type: number
1648 id2: 1646 idOrUUID:
1649 name: id 1647 name: id
1650 in: path 1648 in: path
1651 required: true 1649 required: true
@@ -1666,10 +1664,24 @@ components:
1666 description: "The video channel handle (example: 'my_username@example.com' or 'my_username')" 1664 description: "The video channel handle (example: 'my_username@example.com' or 'my_username')"
1667 schema: 1665 schema:
1668 type: string 1666 type: string
1669 commentId: 1667 subscriptionHandle:
1668 name: subscriptionHandle
1669 in: path
1670 required: true
1671 description: "The subscription handle (example: 'my_username@example.com' or 'my_username')"
1672 schema:
1673 type: string
1674 threadId:
1670 name: threadId 1675 name: threadId
1671 in: path 1676 in: path
1672 required: true 1677 required: true
1678 description: The thread id (root comment id)
1679 schema:
1680 type: number
1681 commentId:
1682 name: commentId
1683 in: path
1684 required: true
1673 description: The comment id 1685 description: The comment id
1674 schema: 1686 schema:
1675 type: number 1687 type: number
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-01 21:34:42 +0000