diff --git a/docs/api/cache.md b/docs/api/cache.md index e082d18f65eba3a467463cab8f19872db3ae35e1..bc3c5240b7de168333a44d598c0882a8a4f0ded1 100644 --- a/docs/api/cache.md +++ b/docs/api/cache.md @@ -44,11 +44,11 @@ Invalidate cache entries. - **`include`** All cache configuration overrides should invalidate cache too. -- **`database`** A database id. +- **`database`** A list of database ids. -- **`dashboard`** A dashboard id. +- **`dashboard`** A list of dashboard ids. -- **`question`** A question id. +- **`question`** A list of question ids. ## `PUT /api/cache/` diff --git a/docs/api/collection.md b/docs/api/collection.md index 86f7ac2c88603f7e2b8943fdf1a2e8af8179c0ca..6774a593f0ea721e19f64e5017ab182710659047 100644 --- a/docs/api/collection.md +++ b/docs/api/collection.md @@ -223,10 +223,14 @@ Modify an existing Collection, including archiving or unarchiving it, or moving ## `PUT /api/collection/graph` -Do a batch update of Collections Permissions by passing in a modified graph. - Will overwrite parts of the graph that are present in the request, and leave the rest unchanged. +Do a batch update of Collections Permissions by passing in a modified graph. Will overwrite parts of the graph that + are present in the request, and leave the rest unchanged. - If the `skip_graph` query parameter is true, it will only return the current revision. + If the `force` query parameter is `true`, a `revision` number is not required. The provided graph will be persisted + as-is, and has the potential to clobber other writes that happened since the last read. + + If the `skip_graph` query parameter is `true`, it will only return the current revision, not the entire permissions + graph. You must be a superuser to do this. @@ -234,11 +238,13 @@ You must be a superuser to do this. - **`namespace`** nullable value must be a non-blank string. -- **`revision`** value must be an integer. +- **`revision`** nullable value must be an integer. - **`groups`** map. -- **`skip_graph`** nullable value must be a valid boolean string ('true' or 'false'). +- **`skip-graph`** nullable value must be a valid boolean string ('true' or 'false'). + +- **`force`** nullable value must be a valid boolean string ('true' or 'false'). --- diff --git a/docs/api/ee/advanced-permissions-application.md b/docs/api/ee/advanced-permissions-application.md index 7f5a4303dcb1619aec2801adc6fdf6e0b53f9f02..b8fee8e9faf24cd081383312abd47442486b89f8 100644 --- a/docs/api/ee/advanced-permissions-application.md +++ b/docs/api/ee/advanced-permissions-application.md @@ -24,6 +24,14 @@ Do a batch update of Application Permissions by passing a modified graph. You must be a superuser to do this. +### PARAMS: + +- **`skip-graph`** nullable value must be a valid boolean string ('true' or 'false'). + +- **`force`** nullable value must be a valid boolean string ('true' or 'false'). + +- **`body`** map. + --- [<< Back to API index](../../api-documentation.md) \ No newline at end of file diff --git a/docs/api/permissions.md b/docs/api/permissions.md index 7444843d62a4e9caeb191d3336e2999d4c0023c2..a6b51e5189f4f17cd83c31faa1168f712a3190a0 100644 --- a/docs/api/permissions.md +++ b/docs/api/permissions.md @@ -118,7 +118,9 @@ You must be a superuser to do this. ### PARAMS: -- **`skip-graph`** nullable boolean. +- **`skip-graph`** nullable value must be a valid boolean string ('true' or 'false'). + +- **`force`** nullable value must be a valid boolean string ('true' or 'false'). - **`body`** map.