aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2021-02-01 15:39:13 +0100
committerChocobozzz <me@florianbigard.com>2021-02-01 15:39:13 +0100
commit6d989edc66e7b541fcf97c2a4a6f91cbf960060a (patch)
tree9c72977cf05eee2b3a84dd1867ec60ef491b0900 /support/doc/api
parentcb5c2abc99c2e222fe18621f79cb68b805678e15 (diff)
downloadPeerTube-6d989edc66e7b541fcf97c2a4a6f91cbf960060a.tar.gz
PeerTube-6d989edc66e7b541fcf97c2a4a6f91cbf960060a.tar.zst
PeerTube-6d989edc66e7b541fcf97c2a4a6f91cbf960060a.zip
Add ability to update plugin auth
Diffstat (limited to 'support/doc/api')
-rw-r--r--support/doc/api/openapi.yaml29
1 files changed, 25 insertions, 4 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index b05a113ca..49616bcaa 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -3898,6 +3898,13 @@ components:
3898 - 2 3898 - 2
3899 description: 'The user role (Admin = `0`, Moderator = `1`, User = `2`)' 3899 description: 'The user role (Admin = `0`, Moderator = `1`, User = `2`)'
3900 example: 2 3900 example: 2
3901 UserAdminFlags:
3902 type: integer
3903 enum:
3904 - 0
3905 - 1
3906 description: 'Admin flags for the user (None = `0`, Bypass video blacklist = `1`)'
3907 example: 1
3901 3908
3902 VideoStateConstant: 3909 VideoStateConstant:
3903 properties: 3910 properties:
@@ -5022,6 +5029,9 @@ components:
5022 type: string 5029 type: string
5023 format: email 5030 format: email
5024 description: The user email 5031 description: The user email
5032 pluginAuth:
5033 type: string
5034 description: Auth plugin to use to authenticate the user
5025 theme: 5035 theme:
5026 type: string 5036 type: string
5027 description: Theme enabled by this user 5037 description: Theme enabled by this user
@@ -5099,8 +5109,13 @@ components:
5099 videoQuotaDaily: 5109 videoQuotaDaily:
5100 type: integer 5110 type: integer
5101 description: The user daily video quota 5111 description: The user daily video quota
5112 channelName:
5113 type: string
5114 description: The user default channel username
5102 role: 5115 role:
5103 $ref: '#/components/schemas/UserRole' 5116 $ref: '#/components/schemas/UserRole'
5117 adminFlags:
5118 $ref: '#/components/schemas/UserAdminFlags'
5104 required: 5119 required:
5105 - username 5120 - username
5106 - password 5121 - password
@@ -5117,20 +5132,26 @@ components:
5117 type: string 5132 type: string
5118 format: email 5133 format: email
5119 description: The updated email of the user 5134 description: The updated email of the user
5135 emailVerified:
5136 type: boolean
5137 description: Set the email as verified
5120 videoQuota: 5138 videoQuota:
5121 type: integer 5139 type: integer
5122 description: The updated video quota of the user 5140 description: The updated video quota of the user
5123 videoQuotaDaily: 5141 videoQuotaDaily:
5124 type: integer 5142 type: integer
5125 description: The updated daily video quota of the user 5143 description: The updated daily video quota of the user
5144 pluginAuth:
5145 type: string
5146 nullable: true
5147 description: The auth plugin to use to authenticate the user
5148 example: 'peertube-plugin-auth-saml2'
5126 role: 5149 role:
5127 $ref: '#/components/schemas/UserRole' 5150 $ref: '#/components/schemas/UserRole'
5151 adminFlags:
5152 $ref: '#/components/schemas/UserAdminFlags'
5128 required: 5153 required:
5129 - id 5154 - id
5130 - email
5131 - videoQuota
5132 - videoQuotaDaily
5133 - role
5134 UpdateMe: 5155 UpdateMe:
5135 properties: 5156 properties:
5136 password: 5157 password: