gRPC

gRPC generators.yml reference

View as Markdown

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.

generators.yml
1api:
2  specs:
3    - proto:
4        root: "./proto"
5        target: "proto/service/v1/service.proto"
6        local-generation: true
root
stringRequired

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/

target
string

Path to the target .proto file (e.g., proto/user/v1/user.proto). Omit to generate docs for the entire root folder.

overrides
string

Path to the overrides configuration file. Used for SDK generation only, not for documentation generation.

local-generation
booleanDefaults to false

Whether to compile .proto files locally. Defaults to remote generation (false).