PeerTube · Example Payload

Getjobs

Job

Getjobs 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": "getJobs",
  "method": "GET",
  "path": "/api/v1/jobs/{state}",
  "summary": "List instance jobs",
  "description": "",
  "tags": [
    "Job"
  ],
  "parameters": [
    {
      "name": "state",
      "in": "path",
      "required": true,
      "description": "The state of the job ('' for for no filter)",
      "schema": {
        "type": "string",
        "enum": [
          "",
          "active",
          "completed",
          "failed",
          "waiting",
          "delayed"
        ]
      }
    },
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    },
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    },
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    },
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "successful operation",
      "examples": {}
    }
  }
}