PeerTube · Schema

UpdateMe

VideoDecentralizedFederationOpen SourceActivityPubSelf-HostedStreaming

Properties

Name Type Description
password object
currentPassword object
email object new email used for login and service communications
displayName string new name of the user in its representations
nsfwPolicy string new NSFW display policy
nsfwFlagsDisplayed object
nsfwFlagsHidden object
nsfwFlagsWarned object
nsfwFlagsBlurred object
p2pEnabled boolean whether to enable P2P in the player or not
autoPlayVideo boolean new preference regarding playing videos automatically
autoPlayNextVideo boolean new preference regarding playing following videos automatically
autoPlayNextVideoPlaylist boolean new preference regarding playing following playlist videos automatically
videosHistoryEnabled boolean whether to keep track of watched history or not
videoLanguages array list of languages to filter videos down to
language string default language for this user
theme string
noInstanceConfigWarningModal boolean
noAccountSetupWarningModal boolean
noWelcomeModal boolean
View JSON Schema on GitHub

JSON Schema

UpdateMe.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/peertube/main/json-schema/UpdateMe.json",
  "title": "UpdateMe",
  "properties": {
    "password": {
      "$ref": "#/components/schemas/password"
    },
    "currentPassword": {
      "$ref": "#/components/schemas/password"
    },
    "email": {
      "description": "new email used for login and service communications",
      "allOf": [
        {
          "$ref": "#/components/schemas/User/properties/email"
        }
      ]
    },
    "displayName": {
      "type": "string",
      "description": "new name of the user in its representations",
      "minLength": 3,
      "maxLength": 120
    },
    "nsfwPolicy": {
      "type": "string",
      "description": "new NSFW display policy",
      "enum": [
        "true",
        "false",
        "both"
      ]
    },
    "nsfwFlagsDisplayed": {
      "$ref": "#/components/schemas/NSFWFlag"
    },
    "nsfwFlagsHidden": {
      "$ref": "#/components/schemas/NSFWFlag"
    },
    "nsfwFlagsWarned": {
      "$ref": "#/components/schemas/NSFWFlag"
    },
    "nsfwFlagsBlurred": {
      "$ref": "#/components/schemas/NSFWFlag"
    },
    "p2pEnabled": {
      "type": "boolean",
      "description": "whether to enable P2P in the player or not"
    },
    "autoPlayVideo": {
      "type": "boolean",
      "description": "new preference regarding playing videos automatically"
    },
    "autoPlayNextVideo": {
      "type": "boolean",
      "description": "new preference regarding playing following videos automatically"
    },
    "autoPlayNextVideoPlaylist": {
      "type": "boolean",
      "description": "new preference regarding playing following playlist videos automatically"
    },
    "videosHistoryEnabled": {
      "type": "boolean",
      "description": "whether to keep track of watched history or not"
    },
    "videoLanguages": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "list of languages to filter videos down to"
    },
    "language": {
      "type": "string",
      "description": "default language for this user"
    },
    "theme": {
      "type": "string"
    },
    "noInstanceConfigWarningModal": {
      "type": "boolean"
    },
    "noAccountSetupWarningModal": {
      "type": "boolean"
    },
    "noWelcomeModal": {
      "type": "boolean"
    }
  }
}