Skip to content
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.

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

docs: correct spelling of 'access' #198

Merged
merged 2 commits into from
Sep 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ The command above will generate source code in the `proto/` directory.
## Generating OpenAPI Documentation
To generate the OpenAPI documentation from the protobuf sources you can run the following commands:

> **Note**: You must have [jq](https://jqlang.github.io/jq/download/) installed to run the `format` step below

```bash
./buf.gen.yaml
./scripts/update_swagger.sh docs/openapiv2/apidocs.swagger.json
Expand All @@ -40,4 +42,4 @@ buf format -w
Or you can just use
```bash
make
```
```
2 changes: 1 addition & 1 deletion docs/openapiv2/apidocs.swagger.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion openfga/v1/openfga_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -777,7 +777,7 @@ service OpenFGAService {
"You may also provide a `context` object that will be used to evaluate the conditioned tuples in the system. It is strongly recommended to provide a value for all the input parameters of all the conditions, to ensure that all tuples be evaluated correctly.\n"
"The response will contain the related users in an array in the \"users\" field of the response. These results may include specific objects, usersets \n"
"or type-bound public access. Each of these types of results is encoded in its own type and not represented as a string."
"In cases where a type-bound public acces result is returned (e.g. `user:*`), it cannot be inferred that all subjects\n"
"In cases where a type-bound public access result is returned (e.g. `user:*`), it cannot be inferred that all subjects\n"
"of that type have a relation to the object; it is possible that negations exist and checks should still be queried\n"
"on individual subjects to ensure access to that document."
"The number of users in the response array will be limited by the execution timeout specified in the flag OPENFGA_LIST_USERS_DEADLINE "
Expand Down
112 changes: 56 additions & 56 deletions proto/openfga/v1/openfga_service.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading