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

docs: Update API documentation 

The "modified" field returned by all file manager endpoints and notifications now refers to unix time (in seconds).

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Arksine 2020-10-25 19:50:24 -04:00
parent 7554a599b4
commit 413062f8e8
2 changed files with 18 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/api_changes.md
View File

@ -1,6 +1,13 @@
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.
### October 25th 2020
- The `modified` field reported for files and directories is no
longer represented as a string. It is now a floating point
value representing unix time (in seconds). This can be used
to display the "last modified date" based on the client's
timezone.
### October 21st 2020 ### October 21st 2020
- The `/server/gcode_store` endpoint no longer returns a string - The `/server/gcode_store` endpoint no longer returns a string
in the result's `gcode_store` field. It now returns an in the result's `gcode_store` field. It now returns an

22
docs/web_api.md
View File

@ -422,8 +422,8 @@ path relative to the specified "root". Note that if the query st
```json ```json
[ [
{filename: "file name", {filename: "file name",
size: <file size>, size: <file_size>,
modified: "last modified date", modified: <unix_time>,
...] ...]
``` ```
@ -450,7 +450,7 @@ path relative to the specified "root". Note that if the query st
{ {
filename: "file name", filename: "file name",
size: <file_size>, size: <file_size>,
modified: "last modified date", modified: <unix_time>,
slicer: "Slicer Name", slicer: "Slicer Name",
slicer_version: "<version>", slicer_version: "<version>",
first_layer_height: <mm>, first_layer_height: <mm>,
@ -458,14 +458,14 @@ path relative to the specified "root". Note that if the query st
first_layer_extr_temp: <C>, first_layer_extr_temp: <C>,
layer_height: <mm>, layer_height: <mm>,
object_height: <mm>, object_height: <mm>,
estimated_time: <time in seconds>, estimated_time: <time_in_seconds>,
filament_total: <mm>, filament_total: <mm>,
thumbnails: [ thumbnails: [
{ {
width: <in pixels>, width: <in_pixels>,
height: <in pixels>, height: <in_pixels>,
size: <length of string>, size: <length_of_string>,
data: <base64 string> data: <base64_string>
}, ... }, ...
] ]
} }
@ -498,14 +498,14 @@ subdirectories.
files: [ files: [
{ {
filename: "file name", filename: "file name",
size: <file size>, size: <file_size>,
modified: "last modified date" modified: <unix_time>
}, ... }, ...
], ],
dirs: [ dirs: [
{ {
dirname: "directory name", dirname: "directory name",
modified: "last modified date" modified: <unix_time>
} }
] ]
} }