Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Chris L <[email protected]>
  • Loading branch information
Zelzahn and elroyK authored Jul 24, 2024
1 parent e317870 commit 01da891
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions deliverables/controller.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ The intent of this library is to provide a wrapper around the [@inrupt/solid-cli

Internally, the controller uses a JSON file called `index`, which is stored in the root of the pod, to maintain an overview of the currently managed connections inside of LOAMA. It is entirely possible, though, that the ACL files contain permissions which aren't reflected inside the `index.json`. This is not an issue, as over time and after repeated usage the `index.json` will synchronize naturally.

To have the distinction between this permission is destined to manage an agent/ group and this permission is for the general public a nullable `UserType` object is used. Wherein a null signifies that it's for the public access.
To have the distinction between permissions destined to manage an agent/group and permissions for the general public, a nullable `UserType` object is used, wherein a null signifies that it's for the public access.

## Deviations from `solid-client`

The controller merges the `ControlRead` and `ControlWrite` into `Control`. Furthermore, the `AccessModes` is mapped to a `Permission[]`. As the `AccessModes` is an object where the key is the permission and the value is a boolean indicating if it should be removed or given. In the `Permission[]` this is interpreted as: If it's there it's given, otherwise not.
The controller merges the `ControlRead` and `ControlWrite` into `Control`. Furthermore, the `AccessModes` is mapped to a `Permission[]`. Since`AccessModes` is an object where the key is the permission and the value is a boolean indicating if it should be removed or given, the`Permission[]` array interprets it as: If it's there it's given, otherwise it is not.

0 comments on commit 01da891

Please sign in to comment.