PeerTube · Example Payload

Reordervideoplaylistsofchannel

Video PlaylistsVideo Channels

Reordervideoplaylistsofchannel 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": "reorderVideoPlaylistsOfChannel",
  "method": "POST",
  "path": "/api/v1/video-channels/{channelHandle}/video-playlists/reorder",
  "summary": "Reorder channel playlists",
  "description": "",
  "tags": [
    "Video Playlists",
    "Video Channels"
  ],
  "parameters": [
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    }
  ],
  "requestBody": {
    "contentType": "application/json",
    "schema": {
      "type": "object",
      "properties": {
        "startPosition": {
          "type": "integer",
          "description": "Start position of the element to reorder",
          "minimum": 1
        },
        "insertAfterPosition": {
          "type": "integer",
          "description": "New position for the block to reorder, to add the block before the first element",
          "minimum": 0
        },
        "reorderLength": {
          "type": "integer",
          "description": "How many element from `startPosition` to reorder",
          "minimum": 1
        }
      },
      "required": [
        "startPosition",
        "insertAfterPosition"
      ]
    },
    "example": {}
  },
  "responses": {
    "204": {
      "description": "successful operation",
      "examples": {}
    }
  }
}