Skip to content

Commit 3c23e1a

Browse files
docs: make public and private a bit more clear in permissions (#308)
Signed-off-by: David Dal Busco <david.dalbusco@outlook.com>
1 parent 8df768c commit 3c23e1a

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

docs/build/datastore/collections.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@ Each collection has a set of configurable options that define its behavior and l
2222

2323
## Permissions
2424

25-
A permission defines who can read and write documents in a collection. Permissions can be set to one of the following types: `public`, `private`, `managed`, or `controllers`.
26-
27-
| Permission Type | Description |
28-
| --------------- | ------------------------------------------------------------------------------------------------------- |
29-
| public | Everyone can read or write to any document in the collection. |
30-
| private | Only the owner of a document can read or write to it. |
31-
| managed | The owner of a document and the controllers of the satellite can read or write to it in the collection. |
32-
| controllers | Only the controllers of the satellite can read or write to any document in the collection. |
25+
Permissions define who can read and write documents in a collection. Writing includes creating, updating, and deleting documents.
26+
27+
| Permission Type | Description |
28+
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
29+
| public | Anyone can read or write documents in the collection. |
30+
| private | Only the creator (owner) of a document can read or write to it. However, note that since satellite controllers manage the underlying infrastructure, they have the technical ability to modify access rules by changing its source code. |
31+
| managed | The owner of a document and the controllers of the satellite can read or write to it in the collection. |
32+
| controllers | Only satellite controllers can read or write any document in the collection. |
3333

3434
If not set to immutable, you can modify the permissions at any time, and the changes will take effect immediately.
3535

docs/build/storage/collections.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,20 @@ Each collection has a set of configurable options that define its behavior and l
2222

2323
## Permissions
2424

25-
A permission defines who can read and write documents in a collection. Permissions can be set to one of the following types: `public`, `private`, `managed`, or `controllers`.
25+
Permissions define who can read and write assets in a collection. Writing includes creating (uploading), updating, and deleting assets.
2626

2727
:::caution
2828

2929
Assets are publicly accessible on the Internet regardless of the permission schema. The rules are only applied when reading or writing the data through the library.
3030

3131
:::
3232

33-
| Permission Type | Description |
34-
| --------------- | ------------------------------------------------------------------------------------------------------- |
35-
| public | Everyone can read or write to any document in the collection. |
36-
| private | Only the owner of a document can read or write to it. |
37-
| managed | The owner of a document and the controllers of the satellite can read or write to it in the collection. |
38-
| controllers | Only the controllers of the satellite can read or write to any document in the collection. |
33+
| Permission Type | Description |
34+
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
35+
| public | Anyone can read or write assets in the collection. |
36+
| private | Only the creator (owner) of the asset can read or write to it. However, note that since satellite controllers manage the underlying infrastructure, they have the technical ability to modify access rules by changing its source code. |
37+
| managed | The owner of an asset and the controllers of the satellite can read or write to it in the collection. |
38+
| controllers | Only satellite controllers can read or write any asset in the collection. |
3939

4040
If not set to immutable, you can modify the permissions at any time, and the changes will take effect immediately.
4141

0 commit comments

Comments
 (0)