Skip to content

Commit

Permalink
doc: add additional explanation to the wildcard section in permissions
Browse files Browse the repository at this point in the history
Co-authored-by: Rafael Gonzaga <rafael.nunu@hotmail.com>
  • Loading branch information
jakecastelli and RafaelGSS committed Jul 1, 2024
1 parent c1dc307 commit 00cfbf7
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions doc/api/permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -563,6 +563,14 @@ Wildcards are supported too:
After passing a wildcard character (`*`) all subsequent characters will
be ignored. For example: `/home/*.js` will work similar to `/home/*`.

When the permission model is initialized, it will automatically add a wildcard
(\*) if the specified directory exists. For example, if `/home/test/files`
exists, it will be treated as `/home/test/files/*`. However, if the directory
does not exist, the wildcard will not be added, and access will be limited to
`/home/test/files`. If you want to allow access to a folder that does not exist
yet, make sure to explicitly include the wildcard:
`/my-path/folder-do-not-exist/*`.

#### Permission Model constraints

There are constraints you need to know before using this system:
Expand Down

0 comments on commit 00cfbf7

Please sign in to comment.