3diy
/
moonraker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: document API for retreiving Klipper "docs" 

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Arksine 2020-11-23 06:22:45 -05:00
parent b0f781ec16
commit f96fb997da
3 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -20,4 +20,4 @@ Users:\
[user_changes.md](/docs/user_changes.md) - November 19th 2020 [user_changes.md](/docs/user_changes.md) - November 19th 2020
Developers:\ Developers:\
[api_changes.md](/docs/api_changes.md) - November 19th 2020 [api_changes.md](/docs/api_changes.md) - November 23rd 2020

4
docs/api_changes.md
View File

@ -1,6 +1,10 @@
This document keeps a record of all changes to Moonraker's remote This document keeps a record of all changes to Moonraker's remote
facing APIs. facing APIs.
### November 23rd 2020
- Moonraker now serves Klipper's "docs" directory. This can be access
at `GET /server/files/docs/<filename>`.
### November 19th 2020 ### November 19th 2020
- The path for the power APIs has changed from `gpio_power` to `device_power`: - The path for the power APIs has changed from `gpio_power` to `device_power`:
- `GET /machine/device_power/devices`\ - `GET /machine/device_power/devices`\

11
docs/web_api.md
View File

@ -422,6 +422,7 @@ as the "gcodes" root. The following roots are available:
- gcodes - gcodes
- config - config
- config_examples (read-only) - config_examples (read-only)
- docs (read-only)
Write operations (upload, delete, make directory, remove directory) are Write operations (upload, delete, make directory, remove directory) are
only available on the `gcodes` and config roots. Note that the `config` root only available on the `gcodes` and config roots. Note that the `config` root
@ -722,6 +723,16 @@ to delete a file in a subdirectory.
- Returns:\ - Returns:\
The requested file The requested file
### Download Klipper documentation
- HTTP command:\
`GET /server/files/docs/<file_name>`
- Websocket command:\
Not Available
- Returns:\
The requested file
### Download klippy.log ### Download klippy.log
- HTTP command:\ - HTTP command:\
`GET /server/files/klippy.log` `GET /server/files/klippy.log`