浏览代码

doc: add request example for /share

KernelDeimos 11 月之前
父节点
当前提交
11a135c7b7
共有 1 个文件被更改,包括 21 次插入0 次删除
  1. 21 0
      doc/api/share.md

+ 21 - 0
doc/api/share.md

@@ -44,6 +44,27 @@ different from calling `/grant-user-user` with a permission.
   `heyputer:api/APIError`
 - **dry_run:** `true` if present
 
+### Request Example
+
+```javascript
+await fetch("http://puter.localhost:4100/share", {
+  headers: {
+    "Content-Type": "application/json",
+    "Authorization": `Bearer ${puter.authToken}`,
+  },
+  body: JSON.stringify({
+      // dry_run: true,
+      recipients: [
+          'user_that_gets_shared_to',
+      ],
+      paths: [
+          '/user_that_shares/file_that_gets_shared.txt',
+      ],
+  }),
+  method: "POST",
+});
+```
+
 ### Success Response
 
 ```json