Getsyndicatedvideos 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": "getSyndicatedVideos",
"method": "GET",
"path": "/feeds/videos.{format}",
"summary": "Common videos feeds",
"description": "",
"tags": [
"Video Feeds"
],
"parameters": [
{
"name": "format",
"in": "path",
"required": true,
"description": "format expected (we focus on making `rss` the most feature-rich ; it serves [Media RSS](https://www.rssboard.org/media-rss))",
"schema": {
"type": "string",
"enum": [
"xml",
"rss",
"rss2",
"atom",
"atom1",
"json",
"json1"
]
}
},
{
"name": "accountId",
"in": "query",
"required": false,
"description": "limit listing to a specific account",
"schema": {
"type": "string"
}
},
{
"name": "accountName",
"in": "query",
"required": false,
"description": "limit listing to a specific account",
"schema": {
"type": "string"
}
},
{
"name": "videoChannelId",
"in": "query",
"required": false,
"description": "limit listing to a specific video channel",
"schema": {
"type": "string"
}
},
{
"name": "videoChannelName",
"in": "query",
"required": false,
"description": "limit listing to a specific video channel",
"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": {}
}
],
"requestBody": null,
"responses": {
"200": {
"description": "successful operation",
"examples": {
"application/xml": {
"nightly": {
"externalValue": "https://peertube2.cpy.re/feeds/videos.xml?scope=local"
}
},
"application/rss+xml": {
"nightly": {
"externalValue": "https://peertube2.cpy.re/feeds/videos.rss?scope=local"
}
},
"text/xml": {
"nightly": {
"externalValue": "https://peertube2.cpy.re/feeds/videos.xml?scope=local"
}
},
"application/atom+xml": {
"nightly": {
"externalValue": "https://peertube2.cpy.re/feeds/videos.atom?scope=local"
}
},
"application/json": {
"nightly": {
"externalValue": "https://peertube2.cpy.re/feeds/videos.json?scope=local"
}
}
}
},
"404": {
"description": "video channel or account not found",
"examples": {}
},
"406": {
"description": "accept header unsupported",
"examples": {}
}
}
}