github/plexpy
1
0
Fork 0
mirror of https://github.com/Tautulli/Tautulli.git synced 2025-07-16 02:02:58 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update API docs

Browse source
This commit is contained in:
JonnyWong16 2018-08-27 21:27:09 -07:00
parent ed08df5224
commit 5bb3e189fe
2 changed files with 20 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

14
plexpy/api2.py
View file

@ -413,7 +413,7 @@ class API2:
body (str): The body of the message
Optional parameters:
None
script_args (str): The arguments for script notifications
Returns:
None
@ -496,10 +496,16 @@ class API2:
""" Tries to make a API.md to simplify the api docs. """
head = '''# API Reference\n
The API is still pretty new and needs some serious cleaning up on the backend but should be reasonably functional. There are no error codes yet.
## General structure
The API endpoint is `http://ip:port + HTTP_ROOT + /api/v2?apikey=$apikey&cmd=$command`
The API endpoint is
```
http://IP_ADDRESS:PORT + [/HTTP_ROOT] + /api/v2?apikey=$apikey&cmd=$command
```
Example:
```
http://localhost:8181/api/v2?apikey=66198313a092496b8a725867d2223b5f&cmd=get_metadata&rating_key=153037
```
Response example (default `json`)
```