From 326cfa543c6263818aad7dec4a869bc8139ec14c Mon Sep 17 00:00:00 2001 From: Jokler Date: Sat, 22 Feb 2020 18:53:13 +0100 Subject: Move web server related files into a folder --- templates/docs/api.htm | 126 ------------------------------------------------- 1 file changed, 126 deletions(-) delete mode 100644 templates/docs/api.htm (limited to 'templates/docs/api.htm') diff --git a/templates/docs/api.htm b/templates/docs/api.htm deleted file mode 100644 index a973272..0000000 --- a/templates/docs/api.htm +++ /dev/null @@ -1,126 +0,0 @@ -{% extends "base.htm" %} - -{% block title %}API Documentation{% endblock %} - -{% block content %} -

API Documentation

- - -

Bot list

-

Show a list of all bots.

- -

URL: /api/bots

-

Method: GET

-

Auth required: NO

- -

Success Response

- -

Code: 200 OK

- -

Content example

- - -
-[
-  {
-    "name": "MusicBot",
-    "state": "Playing",
-    "volume": 0.5,
-    "position": {
-      "secs": 10,
-      "nanos": 63573687
-    },
-    "currently_playing": {
-      "url": "<temp_url>",
-      "webpage_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
-      "title": "Rick Astley - Never Gonna Give You Up (Video)",
-      "thumbnail": "https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg",
-      "duration": {
-        "secs": 212,
-        "nanos": 0
-      }
-    },
-    "playlist": [
-      {
-        "url": "<temp_url>",
-        "webpage_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
-        "title": "Rick Astley - Never Gonna Give You Up (Video)",
-        "thumbnail": "https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg",
-        "duration": {
-          "secs": 212,
-          "nanos": 0
-        }
-      }
-    ]
-  }
-]
-
- - -

Show Bot

-

Show a specific bot.

- -

URL: /api/bots/:botname

-

Method: GET

-

Auth required: NO

- -

Success Response

-

Code: 200 OK

- -

Content example

- - -
-{
-  "name": "MusicBot",
-  "state": "Playing",
-  "volume": 0.5,
-  "position": {
-    "secs": 142,
-    "nanos": 690911766
-  },
-  "currently_playing": {
-    "url": "<temp_url>",
-    "webpage_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
-    "title": "Rick Astley - Never Gonna Give You Up (Video)",
-    "thumbnail": "https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg",
-    "duration": {
-      "secs": 212,
-      "nanos": 0
-    }
-  },
-  "playlist": [
-    {
-      "url": "<temp_url>",
-      "webpage_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
-      "title": "Rick Astley - Never Gonna Give You Up (Video)",
-      "thumbnail": "https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg",
-      "duration": {
-        "secs": 212,
-        "nanos": 0
-      }
-    }
-  ]
-}
-
- -

Error Response

- -

Condition: If ':botname' is not connected to TeamSpeak.

- -

Code: 404 NOT FOUND

- -Content: - - -
-{
-  "error": "Not Found",
-  "description": "The requested resource was not found"
-}
-
- -{% endblock %} -- cgit v1.2.3-70-g09d2