Docs: Add example to the disk-space

riotkit-org · Nov 16, 2020 · 10c2dea · 10c2dea
1 parent d6d0093
commit 10c2dea
Showing 1 changed file with 16 additions and 1 deletion.
diff --git a/infracheck/checks/disk-space b/infracheck/checks/disk-space
@@ -7,10 +7,25 @@ disk-space
 
 Monitors disk space.
 
-Parameters:
+**Parameters:**
 
 - min_req_space (in gigabytes)
 - dir (path)
+
+
+**Example JSON:**
+
+.. code:: json
+
+    {
+        "type": "disk-space",
+        "input": {
+            "dir": "/",
+            "min_req_space": "6"
+        }
+    }
+
+
 </sphinx>
 """
 import os