Skip to content

authzed/api

Repository files navigation

Authzed API

License Docs Build Status Discord Server Twitter

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

We use Buf to distribute these definitions and generate source code from them. The definitions are published in Buf Registry Authzed API repository.

You can find more info on HTTP API usage and the versioning and deprecation policy in the Authzed Docs.

You can also use our Postman collection to explore the API.

See CONTRIBUTING.md for instructions on how to contribute.

Development

You can run mage to see the available commands for development. We assume you have a Mac computer.

Warnings ⚠️

  • The version field found in various buf YAML configurations is actually the version of the schema of the YAML file and is not related to the version of the definitions.