diff --git a/docs/content/modeling/testing-models.mdx b/docs/content/modeling/testing-models.mdx index dcedaf41f..7ded6c70a 100644 --- a/docs/content/modeling/testing-models.mdx +++ b/docs/content/modeling/testing-models.mdx @@ -26,7 +26,7 @@ The `.fga.yaml` contains tests for model or a reference to an external model file in `fga` or `json` format | +| `model` or `model_file` | An model or a reference to an external model file in `fga`, `json` or `mod` format | |`tuples or tuple_file` (optional) | A set of tuples or a reference to an external tuple file in `json`, `yaml` or `csv` format. These are considered for all tests. | |`tests` | A set of tests that verify the return values of API calls | @@ -51,7 +51,7 @@ model: | current_time < grant_time + grant_duration } -# tuple_file: ./tuples.yaml # you can specify an external file, or include it inline +# tuple_file: ./tuples.yaml # you can specify an external file, include it inline, or both tuples: # Anne is a member of the Acme organization @@ -79,7 +79,7 @@ Tests have the following structure: | Object | Description | | -------- | -------- | |`name` (optional) | A descriptive name for the test, like “Organization Membership” | -|`tuples` | A set of tuples that are only considered for the test | +|`tuple_file` or `tuples` | A set of tuples that are only considered for the test | |`check` | A set of tests for Check calls, each with a user/object and a set of assertions | |`list_objects` | A set of tests for ListObjects calls, each one with a user/type and a set of assertions for any number of relations| |`list_users` | A set of tests for ListUsers calls, each one with an object and user filter and a set of assertions for the users for any number of relations | @@ -187,6 +187,12 @@ The following is an example of using the `list_users` option in