aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api
diff options
context:
space:
mode:
Diffstat (limited to 'support/doc/api')
-rw-r--r--support/doc/api/openapi.yaml74
1 files changed, 51 insertions, 23 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index b538b6f67..c201b52ba 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -4196,20 +4196,19 @@ components:
4196 maxLength: 36 4196 maxLength: 36
4197 username: 4197 username:
4198 type: string 4198 type: string
4199 description: The username of the user 4199 description: immutable name of the user, used to find or mention its actor
4200 example: chocobozzz 4200 example: chocobozzz
4201 pattern: '/^[a-z0-9._]{1,50}$/' 4201 pattern: '/^[a-z0-9._]{1,50}$/'
4202 minLength: 1 4202 minLength: 1
4203 maxLength: 50 4203 maxLength: 50
4204 usernameChannel: 4204 usernameChannel:
4205 type: string 4205 type: string
4206 description: The username for the default channel 4206 description: immutable name of the channel, used to interact with its actor
4207 example: The Capybara Channel 4207 example: The Capybara Channel
4208 pattern: '/^[ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789\\-_.:]+$/' 4208 pattern: '/^[ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789\\-_.:]+$/'
4209 password: 4209 password:
4210 type: string 4210 type: string
4211 format: password 4211 format: password
4212 description: The password of the user
4213 minLength: 6 4212 minLength: 6
4214 maxLength: 255 4213 maxLength: 255
4215 4214
@@ -5019,7 +5018,7 @@ components:
5019 type: string 5018 type: string
5020 format: url 5019 format: url
5021 name: 5020 name:
5022 description: immutable name of the actor 5021 description: immutable name of the actor, used to find or mention it
5023 allOf: 5022 allOf:
5024 - $ref: '#/components/schemas/username' 5023 - $ref: '#/components/schemas/username'
5025 host: 5024 host:
@@ -5055,7 +5054,9 @@ components:
5055 - $ref: '#/components/schemas/User/properties/id' 5054 - $ref: '#/components/schemas/User/properties/id'
5056 displayName: 5055 displayName:
5057 type: string 5056 type: string
5058 description: name displayed on the account's profile 5057 description: editable name of the account, displayed in its representations
5058 minLength: 3
5059 maxLength: 120
5059 description: 5060 description:
5060 type: string 5061 type: string
5061 description: text or bio displayed on the account's profile 5062 description: text or bio displayed on the account's profile
@@ -5806,9 +5807,9 @@ components:
5806 UpdateUser: 5807 UpdateUser:
5807 properties: 5808 properties:
5808 email: 5809 email:
5809 type: string
5810 format: email
5811 description: The updated email of the user 5810 description: The updated email of the user
5811 allOf:
5812 - $ref: '#/components/schemas/User/properties/email'
5812 emailVerified: 5813 emailVerified:
5813 type: boolean 5814 type: boolean
5814 description: Set the email as verified 5815 description: Set the email as verified
@@ -5828,28 +5829,54 @@ components:
5828 adminFlags: 5829 adminFlags:
5829 $ref: '#/components/schemas/UserAdminFlags' 5830 $ref: '#/components/schemas/UserAdminFlags'
5830 UpdateMe: 5831 UpdateMe:
5832 # see shared/models/users/user-update-me.model.ts:
5831 properties: 5833 properties:
5832 password: 5834 password:
5833 $ref: '#/components/schemas/password' 5835 $ref: '#/components/schemas/password'
5836 currentPassword:
5837 $ref: '#/components/schemas/password'
5834 email: 5838 email:
5839 description: new email used for login and service communications
5840 allOf:
5841 - $ref: '#/components/schemas/User/properties/email'
5842 displayName:
5835 type: string 5843 type: string
5836 format: email 5844 description: new name of the user in its representations
5837 description: Your new email 5845 minLength: 3
5846 maxLength: 120
5838 displayNSFW: 5847 displayNSFW:
5839 type: string 5848 type: string
5840 description: Your new displayNSFW 5849 description: new NSFW display policy
5841 enum: 5850 enum:
5842 - 'true' 5851 - 'true'
5843 - 'false' 5852 - 'false'
5844 - both 5853 - both
5854 webTorrentEnabled:
5855 type: boolean
5856 description: whether to enable P2P in the player or not
5845 autoPlayVideo: 5857 autoPlayVideo:
5846 type: boolean 5858 type: boolean
5847 description: Your new autoPlayVideo 5859 description: new preference regarding playing videos automatically
5848 required: 5860 autoPlayNextVideo:
5849 - password 5861 type: boolean
5850 - email 5862 description: new preference regarding playing following videos automatically
5851 - displayNSFW 5863 autoPlayNextVideoPlaylist:
5852 - autoPlayVideo 5864 type: boolean
5865 description: new preference regarding playing following playlist videos automatically
5866 videosHistoryEnabled:
5867 type: boolean
5868 description: whether to keep track of watched history or not
5869 videoLanguages:
5870 type: array
5871 items:
5872 type: string
5873 description: list of languages to filter videos down to
5874 theme:
5875 type: string
5876 noInstanceConfigWarningModal:
5877 type: boolean
5878 noWelcomeModal:
5879 type: boolean
5853 GetMeVideoRating: 5880 GetMeVideoRating:
5854 properties: 5881 properties:
5855 id: 5882 id:
@@ -5881,28 +5908,28 @@ components:
5881 RegisterUser: 5908 RegisterUser:
5882 properties: 5909 properties:
5883 username: 5910 username:
5884 $ref: '#/components/schemas/username' 5911 description: immutable name of the user, used to find or mention its actor
5912 allOf:
5913 - $ref: '#/components/schemas/username'
5885 password: 5914 password:
5886 $ref: '#/components/schemas/password' 5915 $ref: '#/components/schemas/password'
5887 email: 5916 email:
5888 type: string 5917 type: string
5889 format: email 5918 format: email
5890 description: The email of the user 5919 description: email of the user, used for login or service communications
5891 displayName: 5920 displayName:
5892 type: string 5921 type: string
5893 description: The user display name 5922 description: editable name of the user, displayed in its representations
5894 minLength: 1 5923 minLength: 1
5895 maxLength: 120 5924 maxLength: 120
5896 channel: 5925 channel:
5897 type: object 5926 type: object
5927 description: channel base information used to create the first channel of the user
5898 properties: 5928 properties:
5899 name: 5929 name:
5900 $ref: '#/components/schemas/usernameChannel' 5930 $ref: '#/components/schemas/usernameChannel'
5901 displayName: 5931 displayName:
5902 type: string 5932 $ref: '#/components/schemas/VideoChannel/properties/displayName'
5903 description: The display name for the default channel
5904 minLength: 1
5905 maxLength: 120
5906 required: 5933 required:
5907 - username 5934 - username
5908 - password 5935 - password
@@ -5913,6 +5940,7 @@ components:
5913 # GET/POST/PUT properties 5940 # GET/POST/PUT properties
5914 displayName: 5941 displayName:
5915 type: string 5942 type: string
5943 description: editable name of the channel, displayed in its representations
5916 example: Videos of Framasoft 5944 example: Videos of Framasoft
5917 minLength: 1 5945 minLength: 1
5918 maxLength: 120 5946 maxLength: 120