PeerTube · Example Payload

Updateplugin

Plugins

Updateplugin 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": "updatePlugin",
  "method": "POST",
  "path": "/api/v1/plugins/update",
  "summary": "Update a plugin",
  "description": "",
  "tags": [
    "Plugins"
  ],
  "parameters": [],
  "requestBody": {
    "contentType": "application/json",
    "schema": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "npmName": {
              "type": "string",
              "example": "peertube-plugin-auth-ldap"
            }
          },
          "required": [
            "npmName"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "path": {
              "type": "string"
            }
          },
          "required": [
            "path"
          ],
          "additionalProperties": false
        }
      ]
    },
    "example": {}
  },
  "responses": {
    "204": {
      "description": "successful operation",
      "examples": {}
    },
    "400": {
      "description": "should have either `npmName` or `path` set",
      "examples": {}
    },
    "404": {
      "description": "existing plugin not found",
      "examples": {}
    }
  }
}