Skip to content

Latest commit

 

History

History
29 lines (21 loc) · 1.88 KB

README.md

File metadata and controls

29 lines (21 loc) · 1.88 KB

Authzed API

License Build Status Mailing List Discord Server Twitter

This project contains the definitions of Protocol Buffers used by Authzed.

Buf is used to lint and distribute these definitions and generate source code from them.

You can find more info on each API on the Authzed API reference documentation. Additionally, Protobuf API documentation can be found on the Buf Registry Authzed API repository.

See CONTRIBUTING.md for instructions on how to contribute and perform common tasks like building the project and running tests.

⚠️ Warnings ⚠️

  • The version field found in various buf YAML configuration is actually schema of the YAML of the file and is not related to the version of the definitions.
  • buf build and buf generate do entirely different things. Building compiles definitions and ensures semantic validity. Generate builds and then produces actual source code according to buf.gen.yaml.