paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-11-03 03:16:10 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update API docs re permissions

Browse Source
This commit is contained in:
shamoon
2023-06-26 09:56:56 -07:00
parent 5851e7f1b7
commit 59ca7bbcf2
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/api.md
View File

@@ -288,10 +288,22 @@ with an optional `set_permissions` parameter which is of the form:
} }
``` ```
!!! note
Arrays should contain user or group ID numbers.
If this parameter is supplied the object's permissions will be overwritten, If this parameter is 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).
### Retrieving full permissions
By default, the API will return a truncated version of object-level
permissions, returning `user_can_change` indicating whether the current user
has edit permissions. You can pass the parameter `full_perms=true` to API
calls to view the full permissions of objects in a format that mirrors the
`set_permissions` parameter above.
## API Versioning ## API Versioning
The REST API is versioned since Paperless-ngx 1.3.0. The REST API is versioned since Paperless-ngx 1.3.0.