aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api/openapi.yaml
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2018-04-24 17:05:32 +0200
committerChocobozzz <me@florianbigard.com>2018-04-24 17:12:57 +0200
commit48dce1c90dff4e90a4bcffefaecf157336cf904b (patch)
tree478de23812d0bfd93f47e9ad6ad8888c9edcc235 /support/doc/api/openapi.yaml
parent82e392f8a42a19815e932dd386e96e61ebe6d191 (diff)
downloadPeerTube-48dce1c90dff4e90a4bcffefaecf157336cf904b.tar.gz
PeerTube-48dce1c90dff4e90a4bcffefaecf157336cf904b.tar.zst
PeerTube-48dce1c90dff4e90a4bcffefaecf157336cf904b.zip
Update video channel routes
Diffstat (limited to 'support/doc/api/openapi.yaml')
-rw-r--r--support/doc/api/openapi.yaml72
1 files changed, 46 insertions, 26 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 10f60175d..4a1f06d00 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -91,7 +91,7 @@ paths:
91 in: path 91 in: path
92 required: true 92 required: true
93 type: string 93 type: string
94 enum: ['xml', 'atom' 'json'] 94 enum: [ 'xml', 'atom', 'json']
95 default: 'xml' 95 default: 'xml'
96 description: 'The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and json to JSON FEED 1.0' 96 description: 'The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and json to JSON FEED 1.0'
97 - name: accountId 97 - name: accountId
@@ -967,7 +967,7 @@ paths:
967 type: array 967 type: array
968 items: 968 items:
969 $ref: '#/definitions/VideoBlacklist' 969 $ref: '#/definitions/VideoBlacklist'
970 /videos/channels: 970 /video-channels:
971 get: 971 get:
972 tags: 972 tags:
973 - VideoChannel 973 - VideoChannel
@@ -998,6 +998,27 @@ paths:
998 type: array 998 type: array
999 items: 999 items:
1000 $ref: '#/definitions/VideoChannel' 1000 $ref: '#/definitions/VideoChannel'
1001 /accounts/{accountId}/video-channels:
1002 get:
1003 tags:
1004 - VideoChannel
1005 consumes:
1006 - application/json
1007 produces:
1008 - application/json
1009 parameters:
1010 - name: accountId
1011 in: path
1012 required: true
1013 type: string
1014 description: 'The account id '
1015 responses:
1016 '200':
1017 description: successful operation
1018 schema:
1019 type: array
1020 items:
1021 $ref: '#/definitions/VideoChannel'
1001 post: 1022 post:
1002 security: 1023 security:
1003 - OAuth2: [ ] 1024 - OAuth2: [ ]
@@ -1008,6 +1029,11 @@ paths:
1008 produces: 1029 produces:
1009 - application/json 1030 - application/json
1010 parameters: 1031 parameters:
1032 - name: accountId
1033 in: path
1034 required: true
1035 type: string
1036 description: 'The account id '
1011 - in: body 1037 - in: body
1012 name: body 1038 name: body
1013 schema: 1039 schema:
@@ -1015,7 +1041,7 @@ paths:
1015 responses: 1041 responses:
1016 '204': 1042 '204':
1017 description: successful operation 1043 description: successful operation
1018 "/videos/channels/{id}": 1044 "/account/{accountId}/video-channels/{id}":
1019 get: 1045 get:
1020 tags: 1046 tags:
1021 - VideoChannel 1047 - VideoChannel
@@ -1024,11 +1050,16 @@ paths:
1024 produces: 1050 produces:
1025 - application/json 1051 - application/json
1026 parameters: 1052 parameters:
1053 - name: accountId
1054 in: path
1055 required: true
1056 type: string
1057 description: 'The account id '
1027 - name: id 1058 - name: id
1028 in: path 1059 in: path
1029 required: true 1060 required: true
1030 type: string 1061 type: string
1031 description: 'The video id ' 1062 description: 'The video channel id '
1032 responses: 1063 responses:
1033 '200': 1064 '200':
1034 description: successful operation 1065 description: successful operation
@@ -1044,11 +1075,16 @@ paths:
1044 produces: 1075 produces:
1045 - application/json 1076 - application/json
1046 parameters: 1077 parameters:
1078 - name: accountId
1079 in: path
1080 required: true
1081 type: string
1082 description: 'The account id '
1047 - name: id 1083 - name: id
1048 in: path 1084 in: path
1049 required: true 1085 required: true
1050 type: string 1086 type: string
1051 description: 'The video id ' 1087 description: 'The video channel id '
1052 - in: body 1088 - in: body
1053 name: body 1089 name: body
1054 schema: 1090 schema:
@@ -1066,35 +1102,19 @@ paths:
1066 produces: 1102 produces:
1067 - application/json 1103 - application/json
1068 parameters: 1104 parameters:
1069 - name: id 1105 - name: accountId
1070 in: path 1106 in: path
1071 required: true 1107 required: true
1072 type: string 1108 type: string
1073 description: 'The video id ' 1109 description: 'The account id '
1074 responses: 1110 - name: id
1075 '204':
1076 description: successful operation
1077 /videos/accounts/{accountId}/channels:
1078 get:
1079 tags:
1080 - VideoChannel
1081 consumes:
1082 - application/json
1083 produces:
1084 - application/json
1085 parameters:
1086 - name: accountId
1087 in: path 1111 in: path
1088 required: true 1112 required: true
1089 type: string 1113 type: string
1090 description: 'The account id ' 1114 description: 'The video channel id '
1091 responses: 1115 responses:
1092 '200': 1116 '204':
1093 description: successful operation 1117 description: successful operation
1094 schema:
1095 type: array
1096 items:
1097 $ref: '#/definitions/VideoChannel'
1098 "/videos/{videoId}/comment-threads": 1118 "/videos/{videoId}/comment-threads":
1099 get: 1119 get:
1100 tags: 1120 tags: