The generators.yml file serves two roles: it declares your gRPC specification location (in the api.specs section), and configures SDK generation (in the optional groups section).
APIs declared here can be rendered in your documentation via docs.yml. See Generate your API Reference.
Path to the .proto directory root (e.g., proto). Must be specified up to where the package starts. For example, if your package is package.test.v1 at the file path protos/package/test/v1/test_file.proto, the root should be protos/
Path to the target .proto file (e.g., proto/user/v1/user.proto). Omit to generate docs for the entire root folder.
Path to the overrides configuration file, or a list of paths to multiple override files applied sequentially. Used for SDK generation only, not for documentation generation.
Whether to compile .proto files locally. Defaults to remote generation (false). When enabled, you must have buf installed on your machine or in your CI/CD environment (e.g., GitHub Actions).