Skip to content

Commit c139f98

Browse files
authored
Merge pull request #2794 from Permify/omer/entity-naming-rules
docs: add naming conventions for entities
2 parents e9c0bd1 + 0f39397 commit c139f98

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/getting-started/modeling.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,9 @@ The first step to building Permify Schema is creating entities. An entity is an
6060

6161
Think of entities as tables in your database. It is strongly recommended to name entities the same as the corresponding database table name. Doing so allows you to model and reason about your authorization and eliminate the possibility of error.
6262

63-
You can create entities using the `entity` keyword. Let's create some entities for our example GitHub authorization logic.
63+
You can create entities using the `entity` keyword. Entity names may contain only letters and underscores and must be at most 64 characters long.
64+
65+
Let's create some entities for our example GitHub authorization logic.
6466

6567
```perm
6668
entity user {}

0 commit comments

Comments
 (0)