PeerTube · Example Payload

Post_Api_V1_Video Channels_Channelhandle_Give Ownership

Ownership Change

Post_Api_V1_Video Channels_Channelhandle_Give Ownership 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_give-ownership",
  "method": "POST",
  "path": "/api/v1/video-channels/{channelHandle}/give-ownership",
  "summary": "Request channel ownership change",
  "description": "",
  "tags": [
    "Ownership Change"
  ],
  "parameters": [
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    }
  ],
  "requestBody": {
    "contentType": "application/json",
    "schema": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string"
        }
      },
      "required": [
        "username"
      ]
    },
    "example": {}
  },
  "responses": {
    "204": {
      "description": "successful operation",
      "examples": {}
    },
    "400": {
      "description": "changing channel ownership to this target is invalid or there is already a pending ownership request",
      "examples": {}
    },
    "403": {
      "description": "cannot change ownership of this channel",
      "examples": {}
    },
    "404": {
      "description": "channel not found",
      "examples": {}
    }
  }
}