Documentation
¶
Overview ¶
Package serviceconfig reads and parses API service config files.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var APIs = []API{}/* 388 elements not displayed */
APIs defines all API paths and their language availability.
Functions ¶
This section is empty.
Types ¶
type API ¶
type API struct {
// Path is the proto directory path in github.com/googleapis/googleapis.
// If ServiceConfig is empty, the service config is assumed to live at this path.
Path string
// Languages restricts which languages can generate client libraries for this API.
// Empty means all languages can use this API.
//
// Restrictions exist for several reasons:
// - Newer languages (Rust, Dart) skip older beta versions when stable versions exist
// - Python has historical legacy APIs not available to other languages
// - Some APIs (like DIREGAPIC protos) are only used by specific languages
Languages []string
// Discovery is the file path to a discovery document in
// github.com/googleapis/discovery-artifact-manager.
// Used by sidekick languages (Rust, Dart) as an alternative to proto files.
Discovery string
// OpenAPI is the file path to an OpenAPI spec, currently in internal/testdata.
// This is not an official spec yet and exists only for Rust to validate OpenAPI support.
OpenAPI string
// ServiceConfig is the service config file path override.
// If empty, the service config is discovered in the directory specified by Path.
ServiceConfig string
// Title overrides the API title from the service config.
Title string
}
API describes an API path and its availability across languages.
func Find ¶
Find looks up the service config path and title override for a given API path. It first checks the API allowlist for overrides, then searches for YAML files containing "type: google.api.Service", skipping any files ending in _gapic.yaml.
The path should be relative to googleapisDir (e.g., "google/cloud/secretmanager/v1"). Returns an API struct with Path, ServiceConfig, and Title fields populated. ServiceConfig and Title may be empty strings if not found or not configured.
type Authentication ¶
type Authentication = serviceconfig.Authentication
Type aliases for genproto service config types.
type AuthenticationRule ¶
type AuthenticationRule = serviceconfig.AuthenticationRule
Type aliases for genproto service config types.
type BackendRule ¶
type BackendRule = serviceconfig.BackendRule
Type aliases for genproto service config types.
type Documentation ¶
type Documentation = serviceconfig.Documentation
Type aliases for genproto service config types.
type DocumentationRule ¶
type DocumentationRule = serviceconfig.DocumentationRule
Type aliases for genproto service config types.
type OAuthRequirements ¶
type OAuthRequirements = serviceconfig.OAuthRequirements
Type aliases for genproto service config types.
Source Files