chore(sidekick/rust): Add flag to control RPC sample generation (#3240)

Closes googleapis/google-cloud-rust#2689

Note: I've added this flag on the `migrate-sidekick` command also.

Author: amanda-tarafa

devtools/cmd/migrate-sidekick/main.go

@@ -353,6 +353,7 @@ func buildGAPIC(files []string, repoPath string) (map[string]*config.Library, er
 		routingRequired, _ := sidekick.Codec["routing-required"].(string)
 		includeGrpcOnlyMethods, _ := sidekick.Codec["include-grpc-only-methods"].(string)
 		generateSetterSamples, _ := sidekick.Codec["generate-setter-samples"].(string)
+		generateRpcSamples, _ := sidekick.Codec["generate-rpc-samples"].(string)
 		postProcessProtos, _ := sidekick.Codec["post-process-protos"].(string)
 		detailedTracingAttributes, _ := sidekick.Codec["detailed-tracing-attributes"].(string)
 		nameOverrides, _ := sidekick.Codec["name-overrides"].(string)
@@ -401,6 +402,7 @@ func buildGAPIC(files []string, repoPath string) (map[string]*config.Library, er
 			RoutingRequired:           strToBool(routingRequired),
 			IncludeGrpcOnlyMethods:    strToBool(includeGrpcOnlyMethods),
 			GenerateSetterSamples:     strToBool(generateSetterSamples),
+			GenerateRpcSamples:        strToBool(generateRpcSamples),
 			PostProcessProtos:         postProcessProtos,
 			DetailedTracingAttributes: strToBool(detailedTracingAttributes),
 			DocumentationOverrides:    documentationOverrides,
@@ -559,8 +561,9 @@ func buildConfig(libraries map[string]*config.Library, defaults *config.Config)
 		// Check if library has extra configuration beyond just name/api/version
 		hasExtraConfig := lib.CopyrightYear != "" ||
 			(lib.Rust != nil && (lib.Rust.PerServiceFeatures || len(lib.Rust.DisabledRustdocWarnings) > 0 ||
-				len(lib.Rust.PackageDependencies) > 0 || lib.Rust.GenerateSetterSamples ||
-				len(lib.Rust.PaginationOverrides) > 0 || lib.Rust.NameOverrides != ""))
+				lib.Rust.GenerateSetterSamples || lib.Rust.GenerateRpcSamples ||
+				len(lib.Rust.PackageDependencies) > 0 || len(lib.Rust.PaginationOverrides) > 0 ||
+				lib.Rust.NameOverrides != ""))
 		// Only include in libraries section if:
 		// 1. Name doesn't match expected naming convention (name override)
 		// 2. Library has extra configuration

devtools/cmd/migrate-sidekick/main_test.go

@@ -187,6 +187,7 @@ func TestBuildGAPIC(t *testing.T) {
 						RoutingRequired:           true,
 						IncludeGrpcOnlyMethods:    true,
 						GenerateSetterSamples:     true,
+						GenerateRpcSamples:        true,
 						PostProcessProtos:         "example post processing",
 						DetailedTracingAttributes: true,
 						NameOverrides:             ".google.cloud.security/publicca.v1.Storage=StorageControl",
@@ -501,6 +502,7 @@ func TestBuildConfig(t *testing.T) {
 						},
 						PerServiceFeatures:    true,
 						GenerateSetterSamples: true,
+						GenerateRpcSamples:    true,
 						NameOverrides:         ".google.cloud.security/publicca.v1.Storage=StorageControl",
 					},
 				},
@@ -534,6 +536,7 @@ func TestBuildConfig(t *testing.T) {
 							},
 							PerServiceFeatures:    true,
 							GenerateSetterSamples: true,
+							GenerateRpcSamples:    true,
 							NameOverrides:         ".google.cloud.security/publicca.v1.Storage=StorageControl",
 						},
 					},

devtools/cmd/migrate-sidekick/testdata/read-sidekick-files/success-read/nested/.sidekick.toml

@@ -17,6 +17,7 @@ copyright-year = '2025'
 per-service-features      = 'true'
 disabled-rustdoc-warnings = "bare_urls,broken_intra_doc_links,redundant_explicit_links"
 generate-setter-samples = 'true'
+generate-rpc-samples = 'true'
 name-overrides            = '.google.cloud.security/publicca.v1.Storage=StorageControl'
 module-path           = 'crate'
 template-override     = 'templates/mod'
@@ -29,4 +30,4 @@ has-veneer                = 'true'
 routing-required          = 'true'
 include-grpc-only-methods = 'true'
 post-process-protos = 'example post processing'
-detailed-tracing-attributes = 'true'
+detailed-tracing-attributes = 'true'

internal/config/language.go

@@ -149,6 +149,9 @@ type RustCrate struct {
 	// GenerateSetterSamples indicates whether to generate setter samples.
 	GenerateSetterSamples bool `yaml:"generate_setter_samples,omitempty"`
 
+	// GenerateRpcSamples indicates whether to generate RPC samples.
+	GenerateRpcSamples bool `yaml:"generate_rpc_samples,omitempty"`
+
 	// PostProcessProtos indicates whether to post-process protos.
 	PostProcessProtos string `yaml:"post_process_protos,omitempty"`
 

internal/librarian/internal/rust/codec.go

@@ -135,6 +135,9 @@ func buildCodec(library *config.Library) map[string]string {
 	if rust.GenerateSetterSamples {
 		codec["generate-setter-samples"] = "true"
 	}
+	if rust.GenerateRpcSamples {
+		codec["generate-rpc-samples"] = "true"
+	}
 	if rust.NameOverrides != "" {
 		codec["name-overrides"] = rust.NameOverrides
 	}

internal/librarian/internal/rust/codec_test.go

@@ -128,6 +128,7 @@ func TestToSidekickConfig(t *testing.T) {
 					HasVeneer:                 true,
 					RoutingRequired:           true,
 					GenerateSetterSamples:     true,
+					GenerateRpcSamples:        true,
 					DisabledClippyWarnings:    []string{"too_many_arguments"},
 					DefaultFeatures:           []string{"default-feature"},
 					TemplateOverride:          "custom-template",
@@ -156,6 +157,7 @@ func TestToSidekickConfig(t *testing.T) {
 					"has-veneer":                  "true",
 					"routing-required":            "true",
 					"generate-setter-samples":     "true",
+					"generate-rpc-samples":        "true",
 					"disabled-rustdoc-warnings":   "broken_intra_doc_links",
 					"disabled-clippy-warnings":    "too_many_arguments",
 					"default-features":            "default-feature",

internal/sidekick/rust/annotate.go

@@ -72,6 +72,8 @@ type modelAnnotations struct {
 	Incomplete bool
 	// If true, the generator will produce reference documentation samples for message fields setters.
 	GenerateSetterSamples bool
+	// If true, the generator will produce reference documentation samples for functions that correspond to RPCs.
+	GenerateRpcSamples bool
 	// If true, the generated code includes detailed tracing attributes on HTTP
 	// requests.
 	DetailedTracingAttributes bool
@@ -655,6 +657,7 @@ func annotateModel(model *api.API, codec *codec) *modelAnnotations {
 			return slices.ContainsFunc(s.Methods, func(m *api.Method) bool { return !codec.generateMethod(m) })
 		}),
 		GenerateSetterSamples:     codec.generateSetterSamples,
+		GenerateRpcSamples:        codec.generateRpcSamples,
 		DetailedTracingAttributes: codec.detailedTracingAttributes,
 	}
 

internal/sidekick/rust/annotate_test.go

@@ -42,6 +42,7 @@ func TestPackageNames(t *testing.T) {
 		"per-service-features":        "true",
 		"extra-modules":               "operation",
 		"generate-setter-samples":     "true",
+		"generate-rpc-samples":        "true",
 		"detailed-tracing-attributes": "true",
 	})
 	if err != nil {
@@ -62,6 +63,7 @@ func TestPackageNames(t *testing.T) {
 		PerServiceFeatures:        false, // no services
 		ExtraModules:              []string{"operation"},
 		GenerateSetterSamples:     true,
+		GenerateRpcSamples:        true,
 		DetailedTracingAttributes: true,
 	}
 	if diff := cmp.Diff(want, got, cmpopts.IgnoreFields(modelAnnotations{}, "BoilerPlate")); diff != "" {
@@ -1722,6 +1724,20 @@ func TestGenerateSetterSamples(t *testing.T) {
 	}
 }
 
+func TestGenerateRpcSamples(t *testing.T) {
+	model := serviceAnnotationsModel()
+	codec, err := newCodec("protobuf", map[string]string{
+		"generate-rpc-samples": "true",
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+	annotateModel(model, codec)
+	if !model.Codec.(*modelAnnotations).GenerateRpcSamples {
+		t.Errorf("GenerateRpcSamples should be true")
+	}
+}
+
 func TestAnnotateModelWithDetailedTracing(t *testing.T) {
 	tests := []struct {
 		name    string

internal/sidekick/rust/codec.go

@@ -160,6 +160,12 @@ func newCodec(specificationFormat string, options map[string]string) (*codec, er
 				return nil, fmt.Errorf("cannot convert `generate-setter-samples` value %q to boolean: %w", definition, err)
 			}
 			codec.generateSetterSamples = value
+		case key == "generate-rpc-samples":
+			value, err := strconv.ParseBool(definition)
+			if err != nil {
+				return nil, fmt.Errorf("cannot convert `generate-rpc-samples` value %q to boolean: %w", definition, err)
+			}
+			codec.generateRpcSamples = value
 		default:
 			return nil, fmt.Errorf("unknown Rust codec option %q", key)
 		}
@@ -298,6 +304,8 @@ type codec struct {
 	routingRequired bool
 	// If true, the generator will produce reference documentation samples for message fields setters.
 	generateSetterSamples bool
+	// If true, the generator will produce reference documentation samples for functions that correspond to RPCs.
+	generateRpcSamples bool
 }
 
 type systemParameter struct {

internal/sidekick/rust/codec_test.go

@@ -296,6 +296,15 @@ func TestParseOptions(t *testing.T) {
 				c.generateSetterSamples = true
 			},
 		},
+		{
+			Format: "protobuf",
+			Options: map[string]string{
+				"generate-rpc-samples": "true",
+			},
+			Update: func(c *codec) {
+				c.generateRpcSamples = true
+			},
+		},
 	} {
 		want, err := newCodec(test.Format, map[string]string{})
 		if err != nil {
@@ -331,6 +340,7 @@ func TestParseOptionsErrors(t *testing.T) {
 		{Options: map[string]string{"has-veneer": ""}},
 		{Options: map[string]string{"routing-required": ""}},
 		{Options: map[string]string{"generate-setter-samples": ""}},
+		{Options: map[string]string{"generate-rpc-samples": ""}},
 		{Options: map[string]string{"--invalid--": ""}},
 	} {
 		if got, err := newCodec("disco", test.Options); err == nil {
@@ -2031,3 +2041,16 @@ func TestParseOptionsGenerateSetterSamples(t *testing.T) {
 		t.Errorf("generateSetterSamples should be true")
 	}
 }
+
+func TestParseOptionsGenerateRpcSamples(t *testing.T) {
+	options := map[string]string{
+		"generate-rpc-samples": "true",
+	}
+	got, err := newCodec("", options)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if !got.generateRpcSamples {
+		t.Errorf("generateRpcSamples should be true")
+	}
+}