refactor: rename channel to api (#3708)

Author: julieqiu

internal/config/config.go

@@ -192,10 +192,8 @@ type Library struct {
 	// overrides Default.Transport.
 	Transport string `yaml:"transport,omitempty"`
 
-	// Veneer indicates this library has hand-written code with generated
-	// submodules. When true, the library uses language-specific module
-	// configuration (e.g., rust.modules) instead of generating a complete crate
-	// from channels.
+	// Veneer indicates this library has hand-written code. A veneer may
+	// contain generated libraries.
 	Veneer bool `yaml:"veneer,omitempty"`
 
 	// Language-specific fields are below.

internal/librarian/add.go

@@ -45,11 +45,11 @@ func addCommand() *cli.Command {
 			if name == "" {
 				return errMissingLibraryName
 			}
-			var channels []string
+			var apis []string
 			if len(args.Slice()) > 1 {
-				channels = args.Slice()[1:]
+				apis = args.Slice()[1:]
 			}
-			return runAdd(ctx, name, channels...)
+			return runAdd(ctx, name, apis...)
 		},
 	}
 }
@@ -74,15 +74,15 @@ func runAdd(ctx context.Context, name string, channel ...string) error {
 	return nil
 }
 
-func addLibraryToLibrarianConfig(cfg *config.Config, name string, channel ...string) *config.Config {
+func addLibraryToLibrarianConfig(cfg *config.Config, name string, api ...string) *config.Config {
 	lib := &config.Library{
 		Name:          name,
 		CopyrightYear: strconv.Itoa(time.Now().Year()),
 	}
 
-	for _, c := range channel {
+	for _, a := range api {
 		lib.APIs = append(lib.APIs, &config.API{
-			Path: c,
+			Path: a,
 		})
 	}
 	cfg.Libraries = append(cfg.Libraries, lib)

internal/librarian/add_test.go

@@ -238,7 +238,7 @@ func TestAddCommand(t *testing.T) {
 			}
 			if test.wantAPIs != nil {
 				if diff := cmp.Diff(test.wantAPIs, got.APIs); diff != "" {
-					t.Errorf("channels mismatch (-want +got):\n%s", diff)
+					t.Errorf("apis mismatch (-want +got):\n%s", diff)
 				}
 			}
 		})
@@ -249,7 +249,7 @@ func TestAddLibraryToLibrarianYaml(t *testing.T) {
 	for _, test := range []struct {
 		name        string
 		libraryName string
-		channels    []string
+		apis        []string
 		want        []*config.API
 	}{
 		{
@@ -259,7 +259,7 @@ func TestAddLibraryToLibrarianYaml(t *testing.T) {
 		{
 			name:        "library with single API",
 			libraryName: "newlib",
-			channels:    []string{"google/cloud/storage/v1"},
+			apis:        []string{"google/cloud/storage/v1"},
 			want: []*config.API{
 				{
 					Path: "google/cloud/storage/v1",
@@ -269,7 +269,7 @@ func TestAddLibraryToLibrarianYaml(t *testing.T) {
 		{
 			name:        "library with multiple APIs",
 			libraryName: "google-cloud-secret-manager",
-			channels: []string{
+			apis: []string{
 				"google/cloud/secretmanager/v1",
 				"google/cloud/secretmanager/v1beta2",
 				"google/cloud/secrets/v1beta1",
@@ -303,7 +303,7 @@ func TestAddLibraryToLibrarianYaml(t *testing.T) {
 			if err := yaml.Write(librarianConfigPath, cfg); err != nil {
 				t.Fatal(err)
 			}
-			cfg = addLibraryToLibrarianConfig(cfg, test.libraryName, test.channels...)
+			cfg = addLibraryToLibrarianConfig(cfg, test.libraryName, test.apis...)
 			if len(cfg.Libraries) != 2 {
 				t.Errorf("libraries count = %d, want 2", len(cfg.Libraries))
 			}
@@ -316,7 +316,7 @@ func TestAddLibraryToLibrarianYaml(t *testing.T) {
 				t.Errorf("version = %q, want %q", found.Version, "")
 			}
 			if diff := cmp.Diff(test.want, found.APIs); diff != "" {
-				t.Errorf("channels mismatch (-want +got):\n%s", diff)
+				t.Errorf("mismatch (-want +got):\n%s", diff)
 			}
 		})
 	}

internal/librarian/dart/generate.go

@@ -56,7 +56,7 @@ func toSidekickConfig(library *config.Library, ch *config.API, googleapisDir str
 		"googleapis-root": googleapisDir,
 	}
 
-	channel, err := serviceconfig.Find(googleapisDir, ch.Path)
+	api, err := serviceconfig.Find(googleapisDir, ch.Path)
 	if err != nil {
 		return nil, err
 	}
@@ -65,7 +65,7 @@ func toSidekickConfig(library *config.Library, ch *config.API, googleapisDir str
 		General: sidekickconfig.GeneralConfig{
 			Language:            "dart",
 			SpecificationFormat: "protobuf",
-			ServiceConfig:       channel.ServiceConfig,
+			ServiceConfig:       api.ServiceConfig,
 			SpecificationSource: ch.Path,
 		},
 		Source: source,

internal/librarian/generate.go

@@ -167,10 +167,10 @@ func postGenerate(ctx context.Context, language string) error {
 	}
 }
 
-func defaultOutput(language, channel, defaultOut string) string {
+func defaultOutput(language, api, defaultOut string) string {
 	switch language {
 	case languageRust:
-		return rust.DefaultOutput(channel, defaultOut)
+		return rust.DefaultOutput(api, defaultOut)
 	default:
 		return defaultOut
 	}

internal/librarian/library.go

@@ -90,7 +90,7 @@ func mergePackageDependencies(defaults, lib []*config.RustPackageDependency) []*
 
 // libraryOutput returns the output path for a library. If the library has an
 // explicit output path, it returns that. Otherwise, it computes the default
-// output path based on the channel path and default configuration.
+// output path based on the api path and default configuration.
 func libraryOutput(language string, lib *config.Library, defaults *config.Default) string {
 	if lib.Output != "" {
 		return lib.Output
@@ -99,23 +99,23 @@ func libraryOutput(language string, lib *config.Library, defaults *config.Defaul
 		// Veneers require explicit output, so return empty if not set.
 		return ""
 	}
-	channelPath := deriveAPIPath(language, lib.Name)
+	apiPath := deriveAPIPath(language, lib.Name)
 	if len(lib.APIs) > 0 && lib.APIs[0].Path != "" {
-		channelPath = lib.APIs[0].Path
+		apiPath = lib.APIs[0].Path
 	}
 	defaultOut := ""
 	if defaults != nil {
 		defaultOut = defaults.Output
 	}
-	return defaultOutput(language, channelPath, defaultOut)
+	return defaultOutput(language, apiPath, defaultOut)
 }
 
 // prepareLibrary applies language-specific derivations and fills defaults.
 // For Rust libraries without an explicit output path, it derives the output
-// from the first channel path.
+// from the first api path.
 func prepareLibrary(language string, lib *config.Library, defaults *config.Default, fillInDefaults bool) (*config.Library, error) {
 	if len(lib.APIs) == 0 {
-		// If no channels are specified, create an empty channel first
+		// If no apis are specified, create an empty api first
 		lib.APIs = append(lib.APIs, &config.API{})
 	}
 

internal/librarian/library_test.go

@@ -253,43 +253,43 @@ func TestPrepareLibrary(t *testing.T) {
 		language    string
 		output      string
 		veneer      bool
-		channels    []*config.API
+		apis        []*config.API
 		wantOutput  string
 		wantErr     bool
 		wantAPIPath string
 	}{
 		{
-			name:       "empty output derives path from channel",
+			name:       "empty output derives path from api",
 			language:   "rust",
-			channels:   []*config.API{{Path: "google/cloud/secretmanager/v1"}},
+			apis:       []*config.API{{Path: "google/cloud/secretmanager/v1"}},
 			wantOutput: "src/generated/cloud/secretmanager/v1",
 		},
 		{
 			name:       "explicit output keeps explicit path",
 			language:   "rust",
 			output:     "custom/output",
-			channels:   []*config.API{{Path: "google/cloud/secretmanager/v1"}},
+			apis:       []*config.API{{Path: "google/cloud/secretmanager/v1"}},
 			wantOutput: "custom/output",
 		},
 		{
 			name:       "empty output uses default for non-rust",
 			language:   "go",
-			channels:   []*config.API{{Path: "google/cloud/secretmanager/v1"}},
+			apis:       []*config.API{{Path: "google/cloud/secretmanager/v1"}},
 			wantOutput: "src/generated",
 		},
 		{
-			name:        "rust with no channels creates default and derives path",
+			name:        "rust with no apis creates default and derives path",
 			language:    "rust",
-			channels:    nil,
+			apis:        nil,
 			wantOutput:  "src/generated/cloud/secretmanager/v1",
 			wantAPIPath: "google/cloud/secretmanager/v1",
 		},
 		{
-			name:        "veneer rust with no channels does not derive path",
+			name:        "veneer rust with no apis does not derive path",
 			language:    "rust",
 			output:      "src/storage/test/v1",
 			veneer:      true,
-			channels:    nil,
+			apis:        nil,
 			wantOutput:  "src/storage/test/v1",
 			wantAPIPath: "",
 		},
@@ -307,7 +307,7 @@ func TestPrepareLibrary(t *testing.T) {
 		{
 			name:        "rust lib without service config",
 			language:    "rust",
-			channels:    []*config.API{{Path: "google/cloud/orgpolicy/v1"}},
+			apis:        []*config.API{{Path: "google/cloud/orgpolicy/v1"}},
 			wantOutput:  "src/generated/cloud/orgpolicy/v1",
 			wantAPIPath: "google/cloud/orgpolicy/v1",
 		},
@@ -317,7 +317,7 @@ func TestPrepareLibrary(t *testing.T) {
 				Name:   "google-cloud-secretmanager-v1",
 				Output: test.output,
 				Veneer: test.veneer,
-				APIs:   test.channels,
+				APIs:   test.apis,
 			}
 			defaults := &config.Default{
 				Output: "src/generated",
@@ -338,7 +338,7 @@ func TestPrepareLibrary(t *testing.T) {
 			if len(got.APIs) > 0 {
 				ch := got.APIs[0]
 				if test.wantAPIPath != "" && ch.Path != test.wantAPIPath {
-					t.Errorf("got channel path %q, want %q", ch.Path, test.wantAPIPath)
+					t.Errorf("got %q, want %q", ch.Path, test.wantAPIPath)
 				}
 			}
 		})

internal/librarian/python/generate.go

@@ -31,7 +31,7 @@ import (
 // Generate generates a Python client library.
 func Generate(ctx context.Context, library *config.Library, googleapisDir string) error {
 	if len(library.APIs) == 0 {
-		return fmt.Errorf("no channels configured for library %q", library.Name)
+		return fmt.Errorf("no apis configured for library %q", library.Name)
 	}
 
 	// Convert library.Output to absolute path since protoc runs from a
@@ -50,11 +50,9 @@ func Generate(ctx context.Context, library *config.Library, googleapisDir string
 	// Some aspects of generation currently require the repo root. Compute it once here
 	// and pass it down.
 	repoRoot := filepath.Dir(filepath.Dir(outdir))
-
-	// Generate each channel separately.
-	for _, channel := range library.APIs {
-		if err := generateAPI(ctx, channel, library, googleapisDir, repoRoot); err != nil {
-			return fmt.Errorf("failed to generate channel %q: %w", channel.Path, err)
+	for _, api := range library.APIs {
+		if err := generateAPI(ctx, api, library, googleapisDir, repoRoot); err != nil {
+			return fmt.Errorf("failed to generate api %q: %w", api.Path, err)
 		}
 	}
 
@@ -64,19 +62,19 @@ func Generate(ctx context.Context, library *config.Library, googleapisDir string
 
 	// TODO(https://github.com/googleapis/librarian/issues/3146):
 	// Remove the default version fudget here, as Generate should
-	// compute it. For now, use the last component of the first channel path as
+	// compute it. For now, use the last component of the first api path as
 	// the default version.
 	defaultVersion := filepath.Base(library.APIs[0].Path)
 
 	// Generate .repo-metadata.json from the service config in the first
-	// channel.
+	// api.
 	// TODO(https://github.com/googleapis/librarian/issues/3159): stop
 	// hardcoding the language and repo name, instead getting it passed in.
-	channel, err := serviceconfig.Find(googleapisDir, library.APIs[0].Path)
+	api, err := serviceconfig.Find(googleapisDir, library.APIs[0].Path)
 	if err != nil {
 		return fmt.Errorf("failed to find service config: %w", err)
 	}
-	absoluteServiceConfig := filepath.Join(googleapisDir, channel.ServiceConfig)
+	absoluteServiceConfig := filepath.Join(googleapisDir, api.ServiceConfig)
 	if err := repometadata.Generate(library, "python", "googleapis/google-cloud-python", absoluteServiceConfig, defaultVersion, outdir); err != nil {
 		return fmt.Errorf("failed to generate .repo-metadata.json: %w", err)
 	}
@@ -100,32 +98,32 @@ func Generate(ctx context.Context, library *config.Library, googleapisDir string
 	return nil
 }
 
-// generateAPI generates part of a library for a single channel.
-func generateAPI(ctx context.Context, channel *config.API, library *config.Library, googleapisDir, repoRoot string) error {
+// generateAPI generates part of a library for a single api.
+func generateAPI(ctx context.Context, api *config.API, library *config.Library, googleapisDir, repoRoot string) error {
 	// Note: the Python Librarian container generates to a temporary directory,
 	// then the results into owl-bot-staging. We generate straight into
 	// owl-bot-staging instead. The post-processor then moves the files into
 	// the correct final position in the repository.
 	// TODO(https://github.com/googleapis/librarian/issues/3210): generate
 	// directly in place.
 
-	stagingChildDirectory := getStagingChildDirectory(channel.Path)
+	stagingChildDirectory := getStagingChildDirectory(api.Path)
 	stagingDir := filepath.Join(repoRoot, "owl-bot-staging", library.Name, stagingChildDirectory)
 	if err := os.MkdirAll(stagingDir, 0755); err != nil {
 		return err
 	}
-	protocOptions, err := createProtocOptions(channel, library, googleapisDir, stagingDir)
+	protocOptions, err := createProtocOptions(api, library, googleapisDir, stagingDir)
 	if err != nil {
 		return err
 	}
 
-	apiDir := filepath.Join(googleapisDir, channel.Path)
+	apiDir := filepath.Join(googleapisDir, api.Path)
 	protos, err := filepath.Glob(apiDir + "/*.proto")
 	if err != nil {
 		return fmt.Errorf("failed to find protos: %w", err)
 	}
 	if len(protos) == 0 {
-		return fmt.Errorf("no protos found in channel %q", channel.Path)
+		return fmt.Errorf("no protos found in api %q", api.Path)
 	}
 
 	// We want the proto filenames to be relative to googleapisDir
@@ -167,11 +165,11 @@ func createProtocOptions(ch *config.API, library *config.Library, googleapisDir,
 	opts = append(opts, "metadata")
 
 	// Add Python-specific options
-	// First common options that apply to all channels
+	// First common options that apply to all apis
 	if library.Python != nil && len(library.Python.OptArgs) > 0 {
 		opts = append(opts, library.Python.OptArgs...)
 	}
-	// Then options that apply to this specific channel
+	// Then options that apply to this specific api
 	if library.Python != nil && len(library.Python.OptArgsByAPI) > 0 {
 		apiOptArgs, ok := library.Python.OptArgsByAPI[ch.Path]
 		if ok {
@@ -202,12 +200,12 @@ func createProtocOptions(ch *config.API, library *config.Library, googleapisDir,
 	if grpcConfigPath != "" {
 		opts = append(opts, fmt.Sprintf("retry-config=%s", grpcConfigPath))
 	}
-	channel, err := serviceconfig.Find(googleapisDir, ch.Path)
+	api, err := serviceconfig.Find(googleapisDir, ch.Path)
 	if err != nil {
 		return nil, err
 	}
-	if channel != nil && channel.ServiceConfig != "" {
-		opts = append(opts, fmt.Sprintf("service-yaml=%s", channel.ServiceConfig))
+	if api != nil && api.ServiceConfig != "" {
+		opts = append(opts, fmt.Sprintf("service-yaml=%s", api.ServiceConfig))
 	}
 
 	return []string{