docs: update documentation for changes to file_manager

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>

docs/api_changes.md

@@ -1,6 +1,48 @@
 ##
 This document keeps a record of all changes to Moonraker's web APIs.
 
+### May 8th 2021
+- The `file_manager` has been refactored to support system file
+  file events through `inotify`.  Only mutable `roots` are monitored,
+  (currently `gcodes` and `config`).  Subfolders within these
+  these roots are also monitored, however hidden folders are not.
+  The following changes API changes have been made to acccommodate
+  this functionality:
+    - The `notify_filelist_changed` actions have changed.  The new
+      actions are as follows:
+        - `create_file`: sent when a new file has been created.  This
+          includes file uploads and copied files.
+        - `create_dir`: sent when a new directory has been created.
+        - `delete_file`: sent when a file has been deleted.
+        - `delete_dir`: sent when a directory has been deleted.
+        - `move_file`: sent when a file has moved.
+        - `move_dir`: sent when a directory has moved.
+        - `modify_file`: sent when an existing file has been modified
+        - `root_update`: sent when a root directory location has been set.
+          For example, if a user changes the gcode path in Klipper, this
+          action is sent with a `notify_filelist_changed` notification.
+    - File list notifications for gcode files are now only sent after
+      all metadata has been processed.  Likewise, requests to copy,
+      move, or upload a file will only return after metadata has been
+      processed.  Notifications are synced with requests so that the
+      request should always return before the notification is sent.
+    - Thumbnails are now stored in the `.thumbs` directory to prevent
+      changes to thumbnails from emitting filelist notications. This
+      change will be reflected in the metadata's `relative_path` field,
+      so clients that use this field should not need to take additional
+      action.  Note that existing thumbnails will remain in the `thumbs`
+      directory and filelist notifications will be sent for changes to
+      these thumbnails.
+    - The `notify_metadata_update` notification has been removed  Clients
+    - can reliably expect metadata to be available for new or moved gcode
+      files when a request returns.
+    - The return values for several endpoints have been updated.  They
+      now contain information similar to that which is pushed by the
+      `notify_filelist_changed` notification.
+- The deprecated `data` field in gcode metadata has been removed.
+  The `size` field now returns the size of the `.png` file.
+
+
 ### March 15th 2021
 - The `data` field for gcode thumbnails is now deprecated and will
   be removed in the near future.  Thumbnails are now saved to png

docs/web_api.md

@@ -1158,15 +1158,13 @@ modified time, and size.
             "width": 32,
             "height": 32,
             "size": 2596,
-            "data": "{base64_data}"
+            "relative_path": ".thumbs/3DBenchy_0.15mm_PLA_MK3S_2h6m-32x32.png"
-            "relative_path": "thumbs/3DBenchy_0.15mm_PLA_MK3S_2h6m-32x32.png"
         },
         {
             "width": 400,
             "height": 300,
             "size": 73308,
-            "data": "{base64_data}",
+            "relative_path": "lthumbs/3DBenchy_0.15mm_PLA_MK3S_2h6m-400x300.png"
-            "relative_path": "thumbs/3DBenchy_0.15mm_PLA_MK3S_2h6m-400x300.png"
         }
     ],
     "first_layer_bed_temp": 60,
@@ -1181,11 +1179,6 @@ modified time, and size.
     `null`.  They will be updated for each print job if the user has the
     `[history]` component configured
 
-!!! warning
-    The `data` field for each thumbnail is deprecated and will be removed
-    in a future release.  Clients should retrieve the png directly using the
-    `relative_path` field.
-
 #### Get directory information
 Returns a list of files and subdirectories given a supplied path.
 Unlike `/server/files/list`, this command does not walk through
@@ -1285,9 +1278,16 @@ JSON-RPC request:
 }
 ```
 
-Returns:
+Returns: Information about the created directory
-
+```json
-`ok`
+{
+    "item": {
+        "path": "gcodes/testdir",
+        "root": "gcodes"
+    },
+    "action": "create_dir"
+}
+```
 
 #### Delete directory
 Deletes a directory at the specified path.
@@ -1312,9 +1312,16 @@ JSON-RPC request:
     If the specified directory contains files then the delete request
     will fail unless the `force` argument is set to `true`.
 
-Returns:
+Returns:  Information about the deleted directory
-
+```json
-`ok`
+{
+    "item": {
+        "path": "gcodes/testdir",
+        "root": "gcodes"
+    },
+    "action": "delete_dir"
+}
+```
 
 #### Move a file or directory
 Moves a file or directory from one location to another. The following
@@ -1351,9 +1358,22 @@ JSON-RPC request:
 }
 ```
 
-Returns:
+Returns:  Information about the moved file or directory
-
+```json
-`ok`
+{
+    "result": {
+        "item": {
+            "root": "gcodes",
+            "path": "test4/test3"
+        },
+        "source_item": {
+            "path": "gcodes/test4/test3",
+            "root": "gcodes"
+        },
+        "action": "move_dir"
+    }
+}
+```
 
 #### Copy a file or directory
 Copies a file or directory from one location to another.  A successful copy has
@@ -1378,9 +1398,16 @@ JSON-RPC request:
 }
 ```
 
-Returns:
+Returns: Information about the copied file or directory
-
+```json
-`ok`
+{
+    "item": {
+        "root": "gcodes",
+        "path": "test4/Voron_v2_350_aferburner_Filament Cover_0.2mm_ABS.gcode"
+    },
+    "action": "create_file"
+}
+```
 
 #### File download
 Retreives file `filename` at root `root`.  The `filename` must include
@@ -1439,21 +1466,16 @@ Arguments available only for the `gcodes` root:
 
 JSON-RPC request: Not Available
 
-Returns:
+Returns:  Information about the uploaded file.  Note that `print_started`
-
+is only included when the supplied root is set to `gcodes`.
-The name of the uploaded file.
 ```json
 {
-    "result": "{file_name}"
+    "item": {
-}
+        "path": "Lock Body Shim 1mm_0.2mm_FLEX_MK3S_2h30m.gcode",
-```
+        "root": "gcodes"
-
+    },
-If the supplied root is "gcodes", a "print_started" field is also
+    "print_started": false,
-returned.
+    "action": "create_file"
-```json
-{
-    "result": "{file_name}",
-    "print_started": false
 }
 ```
 
@@ -1476,9 +1498,16 @@ JSON-RPC request:
     "id": 1323
 }
 ```
-Returns:
+Returns:  Information about the deleted file
-
+```json
-The name of the deleted file
+{
+    "item": {
+        "path": "Lock Body Shim 1mm_0.2mm_FLEX_MK3S_2h30m.gcode",
+        "root": "gcodes"
+    },
+    "action": "delete_file"
+}
+```
 
 #### Download klippy.log
 HTTP request:
@@ -2908,29 +2937,22 @@ to alert all connected clients of the change:
 }
 ```
 The `source_item` field is only present for `move_item` and
-`copy_item` actions.  The following `action` field will be set
+`copy_item` actions.  The `action` field will be set
 to one of the following values:
 
-- `upload_file`
+- `create_file`
-- `delete_file`
 - `create_dir`
+- `delete_file`
 - `delete_dir`
-- `move_item`
+- `move_file`
-- `copy_item`
+- `move_dir`
+- `modify_file`
+- `root_update`
 
-#### Metadata Update
+Most of the above actions are self explanatory.  The `root_update`
-When a new file is uploaded via the API a websocket notification is broadcast
+notification is sent when a `root` folder has changed its location,
-to all connected clients after parsing is complete:
+for example when a user configures a different gcode file path
-```json
+in Klipper.
-{
-    "jsonrpc": "2.0",
-    "method": "notify_metadata_update",
-    "params": [{metadata}]
-}
-```
-
-Where `metadata` is an object matching that returned from a
-[gcode metadata request](#get-gcode-metadata).
 
 #### Update Manager Response
 The update manager will send asyncronous messages to the client during an