Fix: correct set owner API location in docs, additional test (#4366)

* Fix location of owner in API documentation

* Add additional test for setting another owner
This commit is contained in:
shamoon
2023-10-13 09:16:17 -07:00
committed by GitHub
parent 226c771735
commit e4054d684c
2 changed files with 58 additions and 12 deletions

View File

@@ -272,19 +272,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": [...],
},
}
```
@@ -292,7 +293,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).