Skip to content

docs: Add comprehensive store file format documentation #518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rhamzeh merged 4 commits into from
Jul 7, 2025
Merged

docs: Add comprehensive store file format documentation #518

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
230f11c
docs: add comprehensive store file format documentation
Siddhant-K-code Jun 14, 2025
cb4eed8
docs: enhance STORE_FILE.md with condensed users/objects feature exam…
Siddhant-K-code Jul 7, 2025
b02ddc2
Merge branch 'main' into docs/add-store-file-format-documentation
Siddhant-K-code Jul 7, 2025
573770c
Merge branch 'main' into docs/add-store-file-format-documentation
rhamzeh Jul 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ export FGA_STORE_ID=$(fga store create --model model.fga | jq -r .store.id)
fga store **import**

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

###### Parameters

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

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).
Expand Down Expand Up @@ -606,7 +606,7 @@ tests: # required
###### Example
`fga model test --tests tests.fga.yaml`

For more examples of `.fga.yaml` files, check the [sample-stores repository](https://github.com/openfga/sample-stores/)/
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/)/

###### Response

Expand Down
Loading
Loading