Skip to content

Commit 3761481

Browse files
authored
Update modular-models.mdx (#814)
1 parent 8d80adf commit 3761481

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

docs/content/modeling/modular-models.mdx

+7-5
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,12 @@ import {
2424

2525
<DocumentationNotice />
2626

27-
Modular models allows splitting your authorization module across multiple files and modules, improving upon some of the challenges that may be faced when operating an authorization model within a company, such as:
27+
Authorization is application-specific. In an organization with multiple teams building different applications or modules, each team should be able to define and evolve their authorization policies independently.
2828

29-
- A model can grow large and difficult to understand
30-
- As more teams begin to contribute to a model, the ownership boundaries may not be clear and code review processes might not scale
29+
Modular models allows splitting your authorization model across multiple files and modules, improving upon some of the challenges that may be faced when maintaining an authorization model within a company, such as:
30+
31+
- A model can grow large and difficult to understand.
32+
- As more teams begin to contribute to a model, the ownership boundaries may not be clear and code review processes might not scale.
3133

3234
With modular models, a single model can be split across multiple files in a project. It can be organized in a way that makes sense for the project or teams collaborating on it, and it enables ownership for reviews to be expressed using a feature such as [GitHub's](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners), [GitLab's](https://docs.gitlab.com/ee/user/project/codeowners/) or [Gitea's](https://docs.gitea.com/usage/code-owners) code owners.
3335

@@ -44,9 +46,9 @@ The `fga.mod` is the project file for modular models. This file specifies the sc
4446

4547
### Modules
4648

47-
Modules are declared using the `module` keyword in the DSL, and a module can be written across multiple files. A single file cannot have more than one module.
49+
<ProductName format={ProductNameFormat.ShortForm}/> modules define the types and relations for a specific application module or service.
4850

49-
Currently, modules are stored as metadata but are not used by <ProductName format={ProductNameFormat.ShortForm}/>. Module metadata will be used in upcoming features, such as applying authorization to writing and reading/querying tuples.
51+
Modules are declared using the `module` keyword in the DSL, and a module can be written across multiple files. A single file cannot have more than one module.
5052

5153
### Type Extensions
5254

0 commit comments

Comments
 (0)