doc: add request example for /share

This commit is contained in:
KernelDeimos
2024-06-17 18:44:21 -04:00
parent 807addb4ef
commit 11a135c7b7

View File

@@ -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