Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: improve fs permissions description #47596

Merged
merged 1 commit into from
Apr 19, 2023
Merged

doc: improve fs permissions description #47596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions doc/api/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,9 @@ the [Permission Model][].

The valid arguments for the `--allow-fs-read` flag are:

* `*` - To allow the `FileSystemRead` operations.
* Paths delimited by comma (,) to manage `FileSystemRead` (reading) operations.
* `*` - To allow all `FileSystemRead` operations.
* Paths delimited by comma (`,`) to allow only matching `FileSystemRead`
operations.

Examples can be found in the [File System Permissions][] documentation.

Expand Down Expand Up @@ -200,8 +201,9 @@ the [Permission Model][].

The valid arguments for the `--allow-fs-write` flag are:

* `*` - To allow the `FileSystemWrite` operations.
* Paths delimited by comma (,) to manage `FileSystemWrite` (writing) operations.
* `*` - To allow all `FileSystemWrite` operations.
* Paths delimited by comma (`,`) to allow only matching `FileSystemWrite`
operations.

Examples can be found in the [File System Permissions][] documentation.

Expand Down
6 changes: 4 additions & 2 deletions doc/api/permissions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,8 +520,10 @@ Hello world!

The valid arguments for both flags are:

* `*` - To allow the all operations to given scope (read/write).
* Paths delimited by comma (,) to manage reading/writing operations.
* `*` - To allow all `FileSystemRead` or `FileSystemWrite` operations,
respectively.
* Paths delimited by comma (`,`) to allow only matching `FileSystemRead` or
`FileSystemWrite` operations, respectively.

Example:

Expand Down