diff options
author | Chocobozzz <me@florianbigard.com> | 2018-03-19 12:36:41 +0100 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2018-03-19 14:20:04 +0100 |
commit | 5d00a3d7aa4309f1da5ac7d6e3ed63181eb34952 (patch) | |
tree | 924c46daaac9ef56108d8c449f934b6de344ae72 /support/doc/api/openapi.yaml | |
parent | 09700934b90e2ac7b1b9ed1694d9d4d52735e2e1 (diff) | |
download | PeerTube-5d00a3d7aa4309f1da5ac7d6e3ed63181eb34952.tar.gz PeerTube-5d00a3d7aa4309f1da5ac7d6e3ed63181eb34952.tar.zst PeerTube-5d00a3d7aa4309f1da5ac7d6e3ed63181eb34952.zip |
Update the api documentation
Diffstat (limited to 'support/doc/api/openapi.yaml')
-rw-r--r-- | support/doc/api/openapi.yaml | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 99bf0fd2d..634da66e8 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -69,7 +69,7 @@ paths: | |||
69 | '200': | 69 | '200': |
70 | description: successful operation | 70 | description: successful operation |
71 | schema: | 71 | schema: |
72 | $ref: '#/definitions/ServerConfig' | 72 | $ref: '#/definitions/ServerConfig' |
73 | /jobs: | 73 | /jobs: |
74 | get: | 74 | get: |
75 | tags: | 75 | tags: |
@@ -105,7 +105,7 @@ paths: | |||
105 | schema: | 105 | schema: |
106 | type: array | 106 | type: array |
107 | items: | 107 | items: |
108 | $ref: '#/definitions/Job' | 108 | $ref: '#/definitions/Job' |
109 | '/server/following/{host}': | 109 | '/server/following/{host}': |
110 | delete: | 110 | delete: |
111 | tags: | 111 | tags: |
@@ -1037,6 +1037,12 @@ paths: | |||
1037 | '204': | 1037 | '204': |
1038 | description: successful operation | 1038 | description: successful operation |
1039 | definitions: | 1039 | definitions: |
1040 | VideoConstant: | ||
1041 | properties: | ||
1042 | id: | ||
1043 | type: number | ||
1044 | label: | ||
1045 | type: string | ||
1040 | Video: | 1046 | Video: |
1041 | properties: | 1047 | properties: |
1042 | id: | 1048 | id: |
@@ -1047,18 +1053,12 @@ definitions: | |||
1047 | type: string | 1053 | type: string |
1048 | updatedAt: | 1054 | updatedAt: |
1049 | type: string | 1055 | type: string |
1050 | categoryLabel: | ||
1051 | type: string | ||
1052 | category: | 1056 | category: |
1053 | type: number | 1057 | $ref: "#/definitions/VideoConstant" |
1054 | licenceLabel: | ||
1055 | type: string | ||
1056 | licence: | 1058 | licence: |
1057 | type: number | 1059 | $ref: "#/definitions/VideoConstant" |
1058 | languageLabel: | ||
1059 | type: string | ||
1060 | language: | 1060 | language: |
1061 | type: number | 1061 | $ref: "#/definitions/VideoConstant" |
1062 | description: | 1062 | description: |
1063 | type: string | 1063 | type: string |
1064 | duration: | 1064 | duration: |
@@ -1139,14 +1139,14 @@ definitions: | |||
1139 | type: boolean | 1139 | type: boolean |
1140 | owner: | 1140 | owner: |
1141 | type: object | 1141 | type: object |
1142 | properties: | 1142 | properties: |
1143 | name: | 1143 | name: |
1144 | type: string | 1144 | type: string |
1145 | uuid: | 1145 | uuid: |
1146 | type: string | 1146 | type: string |
1147 | videos: | 1147 | videos: |
1148 | type: array | 1148 | type: array |
1149 | items: | 1149 | items: |
1150 | $ref: "#/definitions/Video" | 1150 | $ref: "#/definitions/Video" |
1151 | VideoComment: | 1151 | VideoComment: |
1152 | properties: | 1152 | properties: |
@@ -1228,7 +1228,7 @@ definitions: | |||
1228 | type: boolean | 1228 | type: boolean |
1229 | role: | 1229 | role: |
1230 | type: string | 1230 | type: string |
1231 | enum: [User, Moderator, Administrator] | 1231 | enum: [User, Moderator, Administrator] |
1232 | videoQuota: | 1232 | videoQuota: |
1233 | type: number | 1233 | type: number |
1234 | createdAt: | 1234 | createdAt: |
@@ -1241,7 +1241,7 @@ definitions: | |||
1241 | $ref: "#/definitions/VideoChannel" | 1241 | $ref: "#/definitions/VideoChannel" |
1242 | ServerConfig: | 1242 | ServerConfig: |
1243 | properties: | 1243 | properties: |
1244 | signup: | 1244 | signup: |
1245 | type: object | 1245 | type: object |
1246 | properties: | 1246 | properties: |
1247 | allowed: | 1247 | allowed: |
@@ -1264,7 +1264,7 @@ definitions: | |||
1264 | properties: | 1264 | properties: |
1265 | max: | 1265 | max: |
1266 | type: number | 1266 | type: number |
1267 | extensions: | 1267 | extensions: |
1268 | type: array | 1268 | type: array |
1269 | items: | 1269 | items: |
1270 | type: string | 1270 | type: string |
@@ -1273,8 +1273,8 @@ definitions: | |||
1273 | properties: | 1273 | properties: |
1274 | file: | 1274 | file: |
1275 | type: object | 1275 | type: object |
1276 | properties: | 1276 | properties: |
1277 | extensions: | 1277 | extensions: |
1278 | type: array | 1278 | type: array |
1279 | items: | 1279 | items: |
1280 | type: string | 1280 | type: string |