From bbf09eb74efc983e06d780bc7cbb48612739a3c0 Mon Sep 17 00:00:00 2001
From: KernelDeimos <eric.alex.dube@gmail.com>
Date: Mon, 17 Jun 2024 20:35:49 -0400
Subject: [PATCH] doc: document path property items in /share

---
 doc/api/share.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/doc/api/share.md b/doc/api/share.md
index 16f3da7c..61b90b51 100644
--- a/doc/api/share.md
+++ b/doc/api/share.md
@@ -28,6 +28,20 @@ different from calling `/grant-user-user` with a permission.
   - **notes:**
     - requirement that file/directory exists
     - requirement of at least one value
+  - **structure:** for `object` values:
+    - **path:** _- required_
+      - **accepts:** `string`
+      - **description:**
+        a Puter file path
+    - **access:** _- required_
+      - **description:** one of: `"read"`, `"write"`
+  - **examples:**
+    - ```json
+      { "path": "/some/path", "access": "read" }
+      ```
+    - ```json
+      { "path": "/some/path" }
+      ```
 - **dry_run:** _- optional_
   - **accepts:** `bool`
   - **description:**