Skip to content

Commit 230f11c

Browse files
docs: add comprehensive store file format documentation
1 parent bb88057 commit 230f11c

2 files changed

Lines changed: 387 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ export FGA_STORE_ID=$(fga store create --model model.fga | jq -r .store.id)
228228
fga store **import**
229229

230230
###### Parameters
231-
* `--file`: File containing the store.
231+
* `--file`: File containing the store. See [Store File Format](docs/STORE_FILE.md) for detailed documentation.
232232
* `--store-id`: Specifies the store id to import into
233233
* `--max-tuples-per-write`: Max tuples to send in a single write (optional, default=1)
234234
* `--max-parallel-requests`: Max requests to send in parallel (optional, default=4)
@@ -525,7 +525,7 @@ fga model **test**
525525

526526
###### Parameters
527527

528-
* `--tests`: Name of the tests file. Must be in yaml format (see below)
528+
* `--tests`: Name of the tests file. Must be in yaml format. See [Store File Format](docs/STORE_FILE.md) for detailed documentation.
529529
* `--verbose`: Outputs the results in JSON
530530

531531
If a model is provided, the test will run in a built-in OpenFGA instance (you do not need a separate server). Otherwise, the test will be run against the configured store of your OpenFGA instance. When running against a remote instance, the tuples will be sent as contextual tuples, and will have to abide by the OpenFGA server limits (20 contextual tuples per request).
@@ -606,7 +606,7 @@ tests: # required
606606
###### Example
607607
`fga model test --tests tests.fga.yaml`
608608

609-
For more examples of `.fga.yaml` files, check the [sample-stores repository](https://github.com/openfga/sample-stores/)/
609+
For more examples of `.fga.yaml` files, check our [Store File Format documentation](docs/STORE_FILE.md) and the [sample-stores repository](https://github.com/openfga/sample-stores/)/
610610

611611
###### Response
612612

0 commit comments

Comments
 (0)