PeerTube · Example Payload

Post_Api_V1_Video Channels_Channelhandle_Banner_Pick

Video Channels

Post_Api_V1_Video Channels_Channelhandle_Banner_Pick is an example object payload from PeerTube, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummarydescriptiontagsparametersrequestBodyresponses

Example Payload

Raw ↑ 
{
  "operationId": "post_api_v1_video-channels_channelHandle_banner_pick",
  "method": "POST",
  "path": "/api/v1/video-channels/{channelHandle}/banner/pick",
  "summary": "Update channel banner",
  "description": "",
  "tags": [
    "Video Channels"
  ],
  "parameters": [
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    }
  ],
  "requestBody": {
    "contentType": "multipart/form-data",
    "schema": {
      "type": "object",
      "properties": {
        "bannerfile": {
          "description": "The file to upload.",
          "type": "string",
          "format": "binary"
        }
      }
    },
    "example": {}
  },
  "responses": {
    "200": {
      "description": "successful operation",
      "examples": {}
    },
    "413": {
      "description": "image file too large",
      "examples": {}
    }
  }
}