lgcosta/paperless-ngx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix location of owner in API documentation

Browse Source
This commit is contained in:
shamoon 2023-10-13 08:14:21 -07:00
parent 226c771735
commit 95a05e1dfd
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/api.md
View File

@ -272,11 +272,12 @@ consumption including the ID of a created document if consumption succeeded.
## Permissions ## Permissions
All objects (documents, tags, etc.) allow setting object-level 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": ...,
"owner": user_id, "set_permissions": {
"view": { "view": {
"users": [...], "users": [...],
"groups": [...], "groups": [...],
@ -292,7 +293,7 @@ with an optional `set_permissions` parameter which is of the form:
Arrays should contain user or group ID numbers. 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 assuming the authenticated user has permission to do so (the user must be
the object owner or a superuser). the object owner or a superuser).