Skip to content

Commit ef6c1de

Browse files
committed
Updated documentation
1 parent 7bb1f37 commit ef6c1de

File tree

2 files changed

+18
-14
lines changed

2 files changed

+18
-14
lines changed

documentation/markdown/documentation/cli/access.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,14 @@ The `url` argument is the target (container) resource for which access is to be
2020
#### options
2121
```
2222
Options:
23-
--acl Displays ACL specific information such as group and default access
2423
-p, --pretty Pretty format
2524
-v, --verbose Log all operations
2625
```
27-
The `--acl` option displays information specific to `.acl` resources,
28-
such as `default` access indicating that the authorization is also enforced on child resources without their own `.acl` file
29-
or `inhereted` access indicating that the access rules are derived from the default access of a parent resource.
26+
Depending on if the target Solid pod is managed using the `WAC` or `ACP`
27+
authorization system, options such as showing `default` access indicating
28+
that the authorization is recursively enforced on child resources without their own `.acl` file
29+
or `inhereted` access indicating that the access rules are derived from the default access of a parent resource
30+
will be restricted to `WAC` based Solid servers.
3031
<br />
3132
The `--pretty` option outputs the information in a table format
3233
<br />
@@ -71,31 +72,34 @@ For a container this allows resources to be added using both PUT and POST reques
7172
#### options
7273
```
7374
Options:
74-
--acl Enables ACL specific operations --default and --group
75-
--default Set the defined permissions as default (only in --acl mode)
76-
--group Process identifier as a group identifier (only in --acl mode)
75+
--default Set the defined permissions as default (only when target pod is hosted on a WAC-based instance)
76+
--group Process identifier as a group identifier (only when target pod is hosted on a WAC-based instance)
7777
-v, --verbose Log all operations
7878
-h, --help display help for command
7979
```
80-
The `--acl` option enables the default and group flags to be used, which are WAC specific operations.
80+
The `--default` option makes the current access rules default for all children resources when defined on a container. Only available for pods hosted on a `WAC`-based Solid server.
8181
<br />
82-
The `--default` option makes the current access rules default for all children resources when defined on a container. Only available in `--acl` mode.
83-
<br />
84-
The `--group` option indicates that the identifier represents a group identifier. Only available in `--acl` mode.
82+
The `--group` option indicates that the identifier represents a group identifier. Only available for pods hosted on a `WAC`-based Solid server.
8583
<br />
8684
The `--verbose` option outputs operation logs.
8785

8886
#### examples
89-
Setting public read permissions for a resource
87+
Setting default public read permissions for a resource hosted on a WAC-based solid pod
9088
```
91-
sld access set https://mypod.org/resource p=r
89+
sld access set https://mypod.org/resource p=r --default
9290
```
9391

9492
Giving access to alice to write to a container
9593
```
9694
sld access set http://mypod.org/container/ http://people.org/alice/webid=w
9795
```
9896

97+
Removing all public permissions from a resource (making it effectively private).
98+
Note that this will also remove any default permissions set on the resource.
99+
```
100+
sld access set https://mypod.org/resource p=
101+
```
102+
99103

100104

101105
## Delete

documentation/mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ nav:
7878
- Overview: documentation/overview.md
7979
- Setup: documentation/setup.md
8080
- Manage Authentication: documentation/cli/authentication.md
81-
- Available Commands: documentation/cli/commands.md
8281
- Manage Resource Access: documentation/cli/access.md
82+
- Available Commands: documentation/cli/commands.md
8383
- Using Aliases: documentation/cli/aliases.md
8484
# - Typescript:
8585
# - Overview: usage/typescript/overview.md

0 commit comments

Comments
 (0)