Skip to content
This repository was archived by the owner on Sep 28, 2023. It is now read-only.

Commit d207679

Browse files
committed
fix index.md table of content
1 parent 2946f23 commit d207679

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
_respo_ states for **Resource Policy** and is tiny, user friendly tool for building RBAC systems based on single `yml` file, mainly with FastAPI framework in mind. In most cases – for even large set of roles and organizations – single file would be enough to provide restricting system access.
44

5-
#### Note, every piece of code in the docs is a tested python/yml file, feel free to use it.
5+
Note, every piece of code in the docs is a tested python/yml file, feel free to use it.
66

77
## 1. YML file with defined permissions, organizations and roles
88

@@ -13,7 +13,7 @@ _respo_ states for **Resource Policy** and is tiny, user friendly tool for build
1313

1414
Note, this is very minimal showcase file, without (optional) **names** and **descriptions** fields for every object so it takes less space.
1515

16-
#### There are 4 sections:
16+
There are 4 sections:
1717

1818
- **metadata**, it will be automatically populated with things like `last_modify` datetime and `created_at` fields
1919
- **permissions**, list of `permission "groups"` (only one – "user" above), where you specify all possible permission names in **resources** and custom rules (nested as you like) so stronger labels will force weaker
@@ -36,7 +36,7 @@ And thats it, yml file got validated and pickled by default to `.respo_cache/__a
3636
{!./examples/index/index001.py!}
3737
```
3838

39-
#### Insights:
39+
Insights:
4040

4141
- Every endpoint has exactly and only exactly **ONE UNIQUE PERMISSION**
4242
- Nested rules are resolved (note, no `user.read_basic` directly in foo role declaration from above, it was resolved by respo) so no need for complex if statements anywhere, any permission inheritance is done during build time using `respo create some_file`

0 commit comments

Comments
 (0)