api

type API struct {
	// Name of the API (e.g. secretmanager).
	Name string
	// Name of the package name in the source specification format. For Protobuf
	// this may be `google.cloud.secretmanager.v1`.
	PackageName string
	// The API Title (e.g. "Secret Manager API" or "Cloud Spanner API").
	Title string
	// The API Description.
	Description string
	// The API Revision. In discovery-based services this is the "revision"
	// attribute.
	Revision string
	// Services are a collection of services that make up the API.
	Services []*Service
	// Messages are a collection of messages used to process request and
	// responses in the API.
	Messages []*Message
	// Enums
	Enums []*Enum
	// State contains helpful information that can be used when generating
	// clients.
	State *APIState
	// ResourceDefinitions contains the data from the `google.api.resource_definition` annotation.
	ResourceDefinitions []*Resource
	// QuickstartService is the service that will be used to generate the quickstart sample
	// at the package level.
	QuickstartService *Service
	// Language specific annotations.
	Codec any
}

type APIState struct {
	// ServiceByID returns a service that is associated with the API.
	ServiceByID map[string]*Service
	// MethodByID returns a method that is associated with the API.
	MethodByID map[string]*Method
	// MessageByID returns a message that is associated with the API.
	MessageByID map[string]*Message
	// EnumByID returns a message that is associated with the API.
	EnumByID map[string]*Enum
	// ResourceByType returns a resource that is associated with the API.
	ResourceByType map[string]*Resource
}

type Discovery struct {
	// The ID of the LRO operation type.
	//
	// For example: ".google.cloud.compute.v1.Operation".
	OperationID string

	// Possible prefixes to match the LRO polling RPCs.
	//
	// In discovery-based services there may be multiple resources and RPCs that
	// service as LRO pollers. The order is important, sidekick picks the first
	// match, so the configuration should list preferred matches first.
	Pollers []*Poller
}

type DiscoveryLro struct {
	// The path parameters required by the polling operation.
	PollingPathParameters []string
	// Language specific annotations.
	Codec any
}

type DocumentationOverride struct {
	ID      string
	Match   string
	Replace string
}

type Enum struct {
	// Documentation for the message.
	Documentation string
	// Name of the attribute.
	Name string
	// ID is a unique identifier.
	ID string
	// Some source specifications allow marking enums as deprecated.
	Deprecated bool
	// Values associated with the Enum.
	Values []*EnumValue
	// The unique integer values, some enums have multiple aliases for the
	// same number (e.g. `enum X { a = 0, b = 0, c = 1 }`).
	UniqueNumberValues []*EnumValue
	// ValuesForExamples contains a subset of values suitable for use in generated samples.
	// e.g. non-deprecated, non-zero values.
	ValuesForExamples []*SampleValue
	// Parent returns the ancestor of this node, if any.
	Parent *Message
	// The Protobuf package this enum belongs to.
	Package string
	// Language specific annotations.
	Codec any
}

type EnumValue struct {
	// Documentation for the message.
	Documentation string
	// Name of the attribute.
	Name string
	// ID is a unique identifier.
	ID string
	// Some source specifications allow marking enum values as deprecated.
	Deprecated bool
	// Number of the attribute.
	Number int32
	// Parent returns the ancestor of this node, if any.
	Parent *Enum
	// Language specific annotations.
	Codec any
}

type Field struct {
	// Documentation for the field.
	Documentation string
	// Name of the attribute.
	Name string
	// ID is a unique identifier.
	ID string
	// Typez is the datatype of the field.
	Typez Typez
	// TypezID is the ID of the type the field refers to. This value is populated
	// for message-like types only.
	TypezID string
	// JSONName is the name of the field as it appears in JSON. Useful for
	// serializing to JSON.
	JSONName string
	// Optional indicates that the field is marked as optional in proto3.
	Optional bool

	// For a given field, at most one of `Repeated` or `Map` is true.
	//
	// Using booleans (as opposed to an enum) makes it easier to write mustache
	// templates.
	//
	// Repeated is true if the field is a repeated field.
	Repeated bool
	// Map is true if the field is a map.
	Map bool
	// Some source specifications allow marking fields as deprecated.
	Deprecated bool
	// IsOneOf is true if the field is related to a one-of and not
	// a proto3 optional field.
	IsOneOf bool
	// Some fields have a type that refers (sometimes indirectly) to the
	// containing message. That triggers slightly different code generation for
	// some languages.
	Recursive bool
	// AutoPopulated is true if the field is eligible to be auto-populated,
	// per the requirements in AIP-4235.
	//
	// That is:
	// - It has Typez == STRING_TYPE
	// - For Protobuf, does not have the `google.api.field_behavior = REQUIRED` annotation
	// - For Protobuf, has the `google.api.field_info.format = UUID4` annotation
	// - For OpenAPI, it is an optional field
	// - For OpenAPI, it has format == "uuid"
	AutoPopulated bool
	// FieldBehavior indicates how the field behaves in requests and responses.
	//
	// For example, that a field is required in requests, or given as output
	// but ignored as input.
	Behavior []FieldBehavior
	// For fields that are part of a OneOf, the group of fields that makes the
	// OneOf.
	Group *OneOf
	// The message that contains this field.
	Parent *Message
	// The message type for this field, can be nil.
	MessageType *Message
	// The enum type for this field, can be nil.
	EnumType *Enum
	// ResourceReference contains the data from the `google.api.resource_reference`
	// annotation.
	ResourceReference *ResourceReference
	// Codec is a placeholder to put language specific annotations.
	Codec any
}

type FieldBehavior int

type Message struct {
	// Documentation for the message.
	Documentation string
	// Name of the attribute.
	Name string
	// ID is a unique identifier.
	ID string
	// Some source specifications allow marking messages as deprecated.
	Deprecated bool
	// Fields associated with the Message.
	Fields []*Field
	// If true, this is a synthetic request message.
	//
	// These messages are created by sidekick when parsing Discovery docs and
	// OpenAPI specifications. The query and request parameters for each method
	// are grouped into a synthetic message.
	SyntheticRequest bool
	// If true, this message is a placeholder / doppelganger for a `api.Service`.
	//
	// These messages are created by sidekick when parsing Discovery docs and
	// OpenAPI specifications. All the synthetic messages for a service need to
	// be grouped under a unique namespace to avoid clashes with similar
	// synthetic messages in other services. Sidekick creates a placeholder
	// message that represents "the service".
	//
	// That is, `service1` and `service2` may both have a synthetic `getRequest`
	// message, with different attributes. We need these to be different
	// messages, with different names. So we create a different parent message
	// for each.
	ServicePlaceholder bool
	// Enums associated with the Message.
	Enums []*Enum
	// Messages associated with the Message. In protobuf these are referred to as
	// nested messages.
	Messages []*Message
	// OneOfs associated with the Message.
	OneOfs []*OneOf
	// Parent returns the ancestor of this message, if any.
	Parent *Message
	// The Protobuf package this message belongs to.
	Package string
	IsMap   bool
	// Indicates that this Message is returned by a standard
	// List RPC and conforms to [AIP-4233](https://google.aip.dev/client-libraries/4233).
	Pagination *PaginationInfo
	// Resource contains the data from the `google.api.resource` annotation.
	Resource *Resource
	// Language specific annotations.
	Codec any
}

type Method struct {
	// Documentation is the documentation for the method.
	Documentation string
	// Name is the name of the attribute.
	Name string
	// ID is a unique identifier.
	ID string
	// Deprecated is true if the method is deprecated.
	Deprecated bool
	// InputTypeID is the ID of the input type for the Method.
	InputTypeID string
	// InputType is the input to the Method.
	InputType *Message
	// OutputTypeID is the ID of the output type for the Method.
	OutputTypeID string
	// OutputType is the output of the Method.
	OutputType *Message
	// ReturnsEmpty is true if the method returns nothing.
	//
	// Protobuf uses the well-known type `google.protobuf.Empty` message to
	// represent this.
	//
	// OpenAPIv3 uses a missing content field:
	//   https://swagger.io/docs/specification/v3_0/describing-responses/#empty-response-body
	ReturnsEmpty bool
	// PathInfo contains information about the HTTP request.
	PathInfo *PathInfo
	// Pagination holds the `page_token` field if the method conforms to the
	// standard defined by [AIP-4233](https://google.aip.dev/client-libraries/4233).
	Pagination *Field
	// ClientSideStreaming is true if the method supports client-side streaming.
	ClientSideStreaming bool
	// ServerSideStreaming is true if the method supports server-side streaming.
	ServerSideStreaming bool
	// OperationInfo contains information for methods returning long-running operations.
	OperationInfo *OperationInfo
	// DiscoveryLro has a value if this is a discovery-style long-running operation.
	DiscoveryLro *DiscoveryLro
	// Routing contains the routing annotations, if any.
	Routing []*RoutingInfo
	// AutoPopulated contains the auto-populated (request_id) field, if any, as defined in
	// [AIP-4235](https://google.aip.dev/client-libraries/4235)
	//
	// The field must be eligible for auto-population, and be listed in the
	// `google.api.MethodSettings.auto_populated_fields` entry in
	// `google.api.Publishing.method_settings` in the service config file.
	AutoPopulated []*Field
	// APIVersion contains the interface-based-versioning version.
	//
	// If this is empty, then the method does not have a version annotation.
	APIVersion string
	// Model is the model this method belongs to, mustache templates use this field to
	// navigate the data structure.
	Model *API
	// Service is the service this method belongs to, mustache templates use this field to
	// navigate the data structure.
	Service *Service
	// `SourceService` is the original service this method belongs to. For most
	// methods `SourceService` and `Service` are the same. For mixins, the
	// source service is the mixin, such as longrunning.Operations.
	SourceService *Service
	// `SourceServiceID` is the original service ID for this method.
	SourceServiceID string
	// IsSimple is true if the method is not a streaming, pagination or LRO method.
	IsSimple bool
	// IsLRO is true if the method is a long-running operation.
	IsLRO bool
	// LongRunningResponseType is the response type of the long-running operation.
	LongRunningResponseType *Message
	// LongRunningReturnsEmpty is true if the long-running operation returns an empty response.
	LongRunningReturnsEmpty bool
	// IsList is true if the method is a list operation.
	IsList bool
	// IsStreaming is true if the method is client-side or server-side streaming.
	IsStreaming bool
	// IsAIPStandard is true if the method is one of the AIP standard methods.
	IsAIPStandard bool
	// IsAIPStandardGet is true if the method is an AIP standard get method.
	IsAIPStandardGet bool
	// IsAIPStandardDelete is true if the method is an AIP standard delete method.
	IsAIPStandardDelete bool
	// IsAIPStandardUndelete is true if the method is an AIP standard undelete method.
	IsAIPStandardUndelete bool
	// IsAIPStandardCreate is true if the method is an AIP standard create method.
	IsAIPStandardCreate bool
	// IsAIPStandardUpdate is true if the method is an AIP standard update method.
	IsAIPStandardUpdate bool
	// IsAIPStandardList is true if the method is an AIP standard list method.
	IsAIPStandardList bool
	// SampleInfo may contain sample generation information for this method,
	// usually if it is an AIP conforming metho.
	SampleInfo *SampleInfo
	// Codec contains language specific annotations.
	Codec any
}

type ModelOverride struct {
	Name        string
	Title       string
	Description string
	IncludedIDs []string
	SkippedIDs  []string
}

type OneOf struct {
	// Name of the attribute.
	Name string
	// ID is a unique identifier.
	ID string
	// Documentation for the field.
	Documentation string
	// Fields associated with the one-of.
	Fields []*Field
	// The best field to show in a oneof related samples.
	// Non deprecated fields are preferred, then scalar, repeated, map fields
	// in that order.
	ExampleField *Field
	// Codec is a placeholder to put language specific annotations.
	Codec any
}

type OperationInfo struct {
	// The metadata type. If there is no metadata, this is set to
	// `.google.protobuf.Empty`.
	MetadataTypeID string
	// The result type. This is the expected type when the long running
	// operation completes successfully.
	ResponseTypeID string
	// The method.
	Method *Method
	// Language specific annotations.
	Codec any
}

type PaginationInfo struct {
	// The field that gives us the next page token.
	NextPageToken *Field
	// PageableItem is the field to be paginated over.
	PageableItem *Field
}

type PaginationOverride struct {
	// The method ID.
	ID string
	// The name of the field used for `items`.
	ItemField string
}

type Pair struct {
	// Key of the pair.
	Key string
	// Value of the pair.
	Value string
}

type PathBinding struct {
	// HTTP Verb.
	//
	// This is one of:
	// - GET
	// - POST
	// - PUT
	// - DELETE
	// - PATCH
	Verb string
	// The path broken by components.
	PathTemplate *PathTemplate
	// Query parameter fields.
	QueryParameters map[string]bool
	// TargetResource contains the results of the resource name identification.
	// This helps identify which resource this path is likely targeting.
	TargetResource *TargetResource
	// Language specific annotations.
	Codec any
}

type PathInfo struct {
	// The list of bindings, including the top-level binding.
	Bindings []*PathBinding
	// Body is the name of the field that should be used as the body of the
	// request.
	//
	// This is a string that may be "*" which indicates that the entire request
	// should be used as the body.
	//
	// If this is empty then the body is not used.
	BodyFieldPath string
	// Language specific annotations.
	Codec any
}

type PathSegment struct {
	Literal  *string
	Variable *PathVariable
}

type PathTemplate struct {
	Segments []PathSegment
	Verb     *string
}

type PathVariable struct {
	FieldPath []string
	Segments  []string
	// Allow characters defined as `reserved` by RFC-6570 1.5 to pass through without
	// percent encoding. See RFC-6570 1.2 for examples.
	AllowReserved bool
}

type Poller struct {
	// An acceptable prefix for the URL path, for example:
	//     `compute/v1/projects/{project}/zones/{zone}`
	Prefix string

	// The corresponding method ID.
	MethodID string
}

type Resource struct {
	// Type identifies the kind of resource (e.g., "cloudresourcemanager.googleapis.com/Project").
	// This string is globally unique and identifies the type of resource across Google Cloud.
	Type string
	// Pattern is a list of resource patterns, where each pattern is a sequence of path segments.
	// This defines the structure of the resource's unique identifier.
	Patterns []ResourcePattern
	// Plural is the plural form of the resource name.
	// For example, for a "Book" resource, Plural would be "books".
	Plural string
	// Singular is the singular form of the resource name.
	// For example, for a "Book" resource, Singular would be "book".
	Singular string
	// Self points to the Message that defines this resource.
	// This creates a back-reference for navigating the API model,
	// allowing a Resource definition to access its originating Message structure.
	Self *Message
	// Language specific annotations.
	Codec any
}

type ResourcePattern []PathSegment

type ResourceReference struct {
	// Type is the unique identifier of the referenced resource's kind (e.g., "library.googleapis.com/Shelf").
	// This string matches the `Type` field in the corresponding `Resource` definition.
	Type string
	// ChildType is the unique identifier of a *child* resource's kind.
	// This is used when a field references a parent resource (e.g., "Shelf"), but the context
	// implies interaction with a specific child type (e.g., "Book" within that shelf).
	ChildType string
	// Language specific annotations.
	Codec any
}

type RoutingInfo struct {
	// The name in `x-goog-request-params`.
	Name string
	// Group the possible variants for the given name.
	//
	// The variants are parsed into the reverse order of definition. AIP-4222
	// declares:
	//
	//   In cases when multiple routing parameters have the same resource ID
	//   path segment name, thus referencing the same header key, the
	//   "last one wins" rule is used to determine which value to send.
	//
	// Reversing the order allows us to implement "the first match wins". That
	// is easier and more efficient in most languages.
	Variants []*RoutingInfoVariant
}

type RoutingInfoCombo struct {
	Items []*RoutingInfoComboItem
}

type RoutingInfoComboItem struct {
	Name    string
	Variant *RoutingInfoVariant
}

type RoutingInfoVariant struct {
	// The sequence of field names accessed to get the routing information.
	FieldPath []string
	// A path template that must match the beginning of the field value.
	Prefix RoutingPathSpec
	// A path template that, if matching, is used in the `x-goog-request-params`.
	Matching RoutingPathSpec
	// A path template that must match the end of the field value.
	Suffix RoutingPathSpec
	// Language specific information
	Codec any
}

type RoutingPathSpec struct {
	// A sequence of matching segments.
	//
	// A template like `projects/*/location/*/**` maps to
	// `["projects", "*", "locations", "*", "**"]`.
	Segments []string
}

type SampleInfo struct {
	// ResourceNameField is the field containing the resource name or parent resource name.
	ResourceNameField *Field
	// ResourceIDField is the field containing the resource ID, usually present in Create methods.
	ResourceIDField *Field
	// MessageField is the field containing the message body to be created or updated.
	MessageField *Field
	// UpdateMaskField is the field containing the update mask, present in Update methods.
	UpdateMaskField *Field
}

type SampleValue struct {
	// The enum value.
	EnumValue *EnumValue
	// The index of the value in the sample list (0-based).
	Index int
}

type Service struct {
	// Documentation for the service.
	Documentation string
	// Name of the attribute.
	Name string
	// ID is a unique identifier.
	ID string
	// Some source specifications allow marking services as deprecated.
	Deprecated bool
	// Methods associated with the Service.
	Methods []*Method
	// DefaultHost fragment of a URL.
	DefaultHost string
	// The Protobuf package this service belongs to.
	Package string

	// The model this service belongs to, mustache templates use this field to
	// navigate the data structure.
	Model *API
	// QuickstartMethod is the method that will be used to generate the quickstart sample
	// for this service.
	QuickstartMethod *Method
	// Language specific annotations.
	Codec any
}

type ServiceDependencies struct {
	Messages []string
	Enums    []string
}

type TargetResource struct {
	// FieldPaths is a list of field name sequences that, when joined, form a resource name.
	// For example, [["project"], ["zone"], ["instance"]] identifies a multi-part resource.
	FieldPaths [][]string

	// Template is the canonical HTTP path template for the resource, derived from the PathBinding's PathTemplate by removing the API version prefix.
	// For example, if the PathTemplate is "//compute.googleapis.com/projects/{project}/zones/{zone}", the Template will be a []PathSegment containing:
	// - a Literal segment for "//compute.googleapis.com"
	// - a Literal segment for "projects"
	// - a Variable segment with FieldPath ["project"]
	// - a Literal segment for "zones"
	// - a Variable segment with FieldPath ["zone"]
	Template []PathSegment
}

type Typez int