Searchvideos 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": "searchVideos",
"method": "GET",
"path": "/api/v1/search/videos",
"summary": "Search videos",
"description": "",
"tags": [
"Search",
"Video"
],
"parameters": [
{
"name": "search",
"in": "query",
"required": true,
"description": "String to search. If the user can make a remote URI search, and the string is an URI then the PeerTube instance will fetch the remote object and add it to its database. Then, you can use the REST API to fetch the complete video information and interact with it.\n",
"schema": {
"type": "string"
}
},
{
"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": {}
},
{
"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": {}
},
{
"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": {}
},
{
"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": {}
},
{
"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": {}
},
{
"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": {}
},
{
"name": null,
"in": null,
"required": false,
"description": "",
"schema": {}
},
{
"name": "startDate",
"in": "query",
"required": false,
"description": "Get videos that are published after this date",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"required": false,
"description": "Get videos that are published before this date",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "originallyPublishedStartDate",
"in": "query",
"required": false,
"description": "Get videos that are originally published after this date",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "originallyPublishedEndDate",
"in": "query",
"required": false,
"description": "Get videos that are originally published before this date",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "durationMin",
"in": "query",
"required": false,
"description": "Get videos that have this minimum duration",
"schema": {
"type": "integer"
}
},
{
"name": "durationMax",
"in": "query",
"required": false,
"description": "Get videos that have this maximum duration",
"schema": {
"type": "integer"
}
}
],
"requestBody": null,
"responses": {
"200": {
"description": "successful operation",
"examples": {}
},
"500": {
"description": "search index unavailable",
"examples": {}
}
}
}