aboutsummaryrefslogtreecommitdiffhomepage
path: root/support
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2019-02-19 17:56:09 +0100
committerChocobozzz <me@florianbigard.com>2019-02-19 17:56:50 +0100
commit28c8e63e55cad24b024fc1d05aa1cfc0257434e5 (patch)
tree997dfbe1162954fb356d50ef6df56632b2ca89a9 /support
parenta18e87559b8255b4b543d87409518b60c073fb69 (diff)
downloadPeerTube-28c8e63e55cad24b024fc1d05aa1cfc0257434e5.tar.gz
PeerTube-28c8e63e55cad24b024fc1d05aa1cfc0257434e5.tar.zst
PeerTube-28c8e63e55cad24b024fc1d05aa1cfc0257434e5.zip
Add video import enpoint in openapi
Diffstat (limited to 'support')
-rw-r--r--support/doc/api/openapi.yaml77
1 files changed, 77 insertions, 0 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index ea419029c..6521c6a65 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -1089,6 +1089,83 @@ paths:
1089 channelId=$CHANNEL_ID \ 1089 channelId=$CHANNEL_ID \
1090 name=$NAME \ 1090 name=$NAME \
1091 "Authorization:Bearer $token" 1091 "Authorization:Bearer $token"
1092 /videos/imports:
1093 post:
1094 summary: Import a torrent or magnetURI or HTTP ressource (if enabled by the instance administrator)
1095 security:
1096 - OAuth2: []
1097 tags:
1098 - Video
1099 responses:
1100 '200':
1101 description: successful operation
1102 content:
1103 application/json:
1104 schema:
1105 $ref: '#/components/schemas/VideoUploadResponse'
1106 requestBody:
1107 content:
1108 multipart/form-data:
1109 schema:
1110 type: object
1111 properties:
1112 torrentfile:
1113 description: Torrent File
1114 type: string
1115 format: binary
1116 targetUrl:
1117 description: HTTP target URL
1118 type: string
1119 magnetUri:
1120 description: Magnet URI
1121 type: string
1122 channelId:
1123 description: Channel id that will contain this video
1124 type: number
1125 thumbnailfile:
1126 description: Video thumbnail file
1127 type: string
1128 previewfile:
1129 description: Video preview file
1130 type: string
1131 privacy:
1132 $ref: '#/components/schemas/VideoPrivacy'
1133 category:
1134 description: Video category
1135 type: string
1136 licence:
1137 description: Video licence
1138 type: string
1139 language:
1140 description: Video language
1141 type: string
1142 description:
1143 description: Video description
1144 type: string
1145 waitTranscoding:
1146 description: Whether or not we wait transcoding before publish the video
1147 type: string
1148 support:
1149 description: Text describing how to support the video uploader
1150 type: string
1151 nsfw:
1152 description: Whether or not this video contains sensitive content
1153 type: string
1154 name:
1155 description: Video name
1156 type: string
1157 tags:
1158 description: Video tags
1159 type: array
1160 items:
1161 type: string
1162 commentsEnabled:
1163 description: Enable or disable comments for this video
1164 type: string
1165 scheduleUpdate: *ref_0
1166 required:
1167 - channelId
1168 - name
1092 /videos/abuse: 1169 /videos/abuse:
1093 get: 1170 get:
1094 summary: Get list of reported video abuses 1171 summary: Get list of reported video abuses