PeerTube · Example Payload

Putvideoplaylistvideo

Video Playlists

Putvideoplaylistvideo 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

{
  "operationId": "putVideoPlaylistVideo",
  "method": "PUT",
  "path": "/api/v1/video-playlists/{playlistId}/videos/{playlistElementId}",
  "summary": "Update a playlist element",
  "description": "",
  "tags": [
    "Video Playlists"
  ],
  "parameters": [
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    },
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    }
  ],
  "requestBody": {
    "contentType": "application/json",
    "schema": {
      "type": "object",
      "properties": {
        "startTimestamp": {
          "type": "integer",
          "format": "seconds",
          "description": "Start the video at this specific timestamp"
        },
        "stopTimestamp": {
          "type": "integer",
          "format": "seconds",
          "description": "Stop the video at this specific timestamp"
        }
      }
    },
    "example": {}
  },
  "responses": {
    "204": {
      "description": "successful operation",
      "examples": {}
    }
  }
}