PeerTube · Example Payload

Post_Api_V1_Abuses_Abuseid_Messages

Abuses

Post_Api_V1_Abuses_Abuseid_Messages 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_abuses_abuseId_messages",
  "method": "POST",
  "path": "/api/v1/abuses/{abuseId}/messages",
  "summary": "Add message to an abuse",
  "description": "",
  "tags": [
    "Abuses"
  ],
  "parameters": [
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    }
  ],
  "requestBody": {
    "contentType": "application/json",
    "schema": {
      "type": "object",
      "properties": {
        "message": {
          "description": "Message to send",
          "type": "string",
          "minLength": 2,
          "maxLength": 3000
        }
      },
      "required": [
        "message"
      ]
    },
    "example": {}
  },
  "responses": {
    "200": {
      "description": "successful operation",
      "examples": {}
    },
    "400": {
      "description": "incorrect request parameters",
      "examples": {}
    }
  }
}