paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-07-30 18:27:45 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' into dev

Browse Source
This commit is contained in:
shamoon
2023-11-13 19:57:08 -08:00
parent 8f2ca5761b 5b83bd03f5
commit 3239c478a5
5 changed files with 71 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/api.md
View File

@@ -282,19 +282,20 @@ consumption including the ID of a created document if consumption succeeded.
## Permissions
All objects (documents, tags, etc.) allow setting object-level permissions
with an optional `set_permissions` parameter which is of the form:
with optional `owner` and / or a `set_permissions` parameters which are of
the form:
```
{
"owner": user_id,
"view": {
"users": [...],
"groups": [...],
},
"change": {
"users": [...],
"groups": [...],
},
"owner": ...,
"set_permissions": {
"view": {
"users": [...],
"groups": [...],
},
"change": {
"users": [...],
"groups": [...],
},
}
```
@@ -302,7 +303,7 @@ with an optional `set_permissions` parameter which is of the form:
Arrays should contain user or group ID numbers.
If this parameter is supplied the object's permissions will be overwritten,
If these parameters are supplied the object's permissions will be overwritten,
assuming the authenticated user has permission to do so (the user must be
the object owner or a superuser).