You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+34-4Lines changed: 34 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,30 @@
1
1
# OpenFGA API
2
-
This project contains the definitions of [Protocol Buffers](https://developers.google.com/protocol-buffers/) used by OpenFGA.
2
+
3
+
The OpenFGA API [Protocol Buffers](https://developers.google.com/protocol-buffers/) definitions.
4
+
5
+
## About
6
+
[OpenFGA](https://openfga.dev) is an open source Fine-Grained Authorization solution inspired by [Google's Zanzibar paper](https://research.google/pubs/pub48190/). It was created by the FGA team at [Auth0/Okta](https://auth0.com) based on [Auth0 Fine-Grained Authorization (FGA)](https://fga.dev), available under [a permissive license (Apache-2)](https://github.com/openfga/rfcs/blob/main/LICENSE) and welcomes community contributions.
7
+
8
+
OpenFGA is designed to make it easy for application builders to model their permission layer, and to add and integrate fine-grained authorization into their applications. OpenFGA’s design is optimized for reliability and low latency at a high scale.
9
+
10
+
## Usage
3
11
4
12
[Buf](https://github.com/bufbuild/buf) is used to manage, package, and generate source code from the protocol buffer definitions. The API definitions
5
13
are pushed to the [`buf.build/openfga/api`](https://buf.build/openfga/api) repository in the Buf Registry.
6
14
7
-
## Building the Generated Sources
15
+
You can find various SDKs autogenerated by buf based on the protobuf definitions here: https://buf.build/openfga/api/sdks/main:protobuf
16
+
17
+
For example, to import the definitions in Go you can do so via the following command:
18
+
19
+
```shell
20
+
go get go.buf.build/openfga/go/openfga/api
21
+
```
22
+
23
+
If you are looking for the currently supported OpenFGA HTTP SDKs, you can find them here: https://github.com/openfga/sdk-generator#currently-supported-sdks
24
+
25
+
## Contributing
26
+
27
+
### Building the Generated Sources
8
28
To generate source code from the protobuf definitions contained in this project you can run the following command:
9
29
10
30
> **Note**: You must have [Buf CLI](https://docs.buf.build/installation) installed to run the following command.
@@ -17,7 +37,7 @@ The command above will generate source code in the `proto/` directory. It will a
17
37
that files requiring auto-generation after `.proto` changes have been updated. There are some cases where that git hook
18
38
may be overly strict. In those cases you can bypass it with `commit --no-verify`.
19
39
20
-
## Use the generated sources in OpenFGA
40
+
###Use the generated sources in OpenFGA
21
41
22
42
1. Generate the sources as above
23
43
2. In the `proto` directory execute the following commands:
@@ -30,7 +50,7 @@ may be overly strict. In those cases you can bypass it with `commit --no-verify`
0 commit comments