Skip to content

chore: make repometadata struct public #4056

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JoeWang1127 merged 2 commits into from
Feb 13, 2026
Merged

chore: make repometadata struct public #4056

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d86c1bd
chore: make repometadata struct public
JoeWang1127 Feb 13, 2026
41bb146
update comments
JoeWang1127 Feb 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 17 additions & 13 deletions internal/repometadata/repometadata.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,14 @@ var (
errNoServiceConfig = errors.New("library has no service config from which to get metadata")
)

type libraryInfo struct {
descriptionOverride string
name string
releaseLevel string
// LibraryInfo contains information about a library that is not available in the service config.
type LibraryInfo struct {
// DescriptionOverride overrides the library description from the service config.
DescriptionOverride string
// Name is the name of the library distribution package.
Name string
// ReleaseLevel is the release level (e.g., "stable", "preview").
ReleaseLevel string
}

// RepoMetadata represents the .repo-metadata.json file structure.
Expand Down Expand Up @@ -101,36 +105,36 @@ func FromLibrary(library *config.Library, language, repo, googleapisDir, default
if api.ServiceConfig == "" {
return fmt.Errorf("failed to generate metadata for %s: %w", library.Name, errNoServiceConfig)
}
info := &libraryInfo{
descriptionOverride: library.DescriptionOverride,
name: library.Name,
releaseLevel: library.ReleaseLevel,
info := &LibraryInfo{
DescriptionOverride: library.DescriptionOverride,
Name: library.Name,
ReleaseLevel: library.ReleaseLevel,
}
return FromAPI(api, info, language, repo, defaultVersion, outdir)
}

// FromAPI generates the .repo-metadata.json file from a serviceconfig.API and additional library information.
func FromAPI(api *serviceconfig.API, info *libraryInfo, language, repo, defaultVersion, outputDir string) error {
func FromAPI(api *serviceconfig.API, info *LibraryInfo, language, repo, defaultVersion, outputDir string) error {
clientDocURL := buildClientDocURL(language, extractNameFromAPIID(api.ServiceName))
metadata := &RepoMetadata{
APIID: api.ServiceName,
NamePretty: cleanTitle(api.Title),
DefaultVersion: defaultVersion,
ClientDocumentation: clientDocURL,
ReleaseLevel: info.releaseLevel,
ReleaseLevel: info.ReleaseLevel,
Language: language,
LibraryType: "GAPIC_AUTO",
Repo: repo,
DistributionName: info.name,
DistributionName: info.Name,
}

metadata.ProductDocumentation = extractBaseProductURL(api.DocumentationURI)
metadata.IssueTracker = api.NewIssueURI
metadata.APIShortname = api.ShortName
metadata.Name = api.ShortName
metadata.APIDescription = api.Description
if info.descriptionOverride != "" {
metadata.APIDescription = info.descriptionOverride
if info.DescriptionOverride != "" {
metadata.APIDescription = info.DescriptionOverride
}

data, err := json.MarshalIndent(metadata, "", " ")
Expand Down
Loading