This project contains the definitions of Protocol Buffers used by OpenFGA.
Buf is used to manage, package, and generate source code from the protocol buffer definitions. The API definitions
are pushed to the buf.build/openfga/api
repository in the Buf Registry.
To generate source code from the protobuf definitions contained in this project you can run the following command:
Note: You must have Buf CLI installed to run the following command.
./buf.gen.yaml
The command above will generate source code in the proto/
directory.
- Generate the sources as above
- In the
proto
directory execute the following commands:go mod init go.buf.build/openfga/go/openfga/api go mod tidy
- In OpenFGA, add the following line to your
go.mod
:replace go.buf.build/openfga/go/openfga/api => /path/to/proto
To generate the OpenAPI documentation from the protobuf sources you can run the following commands:
./buf.gen.yaml
./scripts/update_swagger.sh docs/openapiv2/apidocs.swagger.json