service

type AttributeData struct {
	// Name is the name of the attribute.
	Name string
	// TypeRef is the reference to the attribute type.
	TypeRef string
	// Pointer is true if the attribute is a pointer.
	Pointer bool
}

type Data struct {
	// Name is the service name.
	Name string
	// Description is the service description.
	Description string
	// APIName is the name of the API the service belongs to.
	APIName string
	// APIVersion is the API version.
	APIVersion string
	// StructName is the service struct name.
	StructName string
	// VarName is the service variable name (first letter in lowercase).
	VarName string
	// PathName is the service name as used in file and import paths.
	PathName string
	// PkgName is the name of the package containing the generated service
	// code.
	PkgName string
	// ViewsPkg is the name of the package containing the projected and viewed
	// result types.
	ViewsPkg string
	// Methods lists the service interface methods.
	Methods []*MethodData
	// Schemes is the list of security schemes required by the service methods.
	Schemes SchemesData
	// ServerInterceptors contains the data needed to render the server-side
	// interceptors code.
	ServerInterceptors []*InterceptorData
	// ClientInterceptors contains the data needed to render the client-side
	// interceptors code.
	ClientInterceptors []*InterceptorData
	// Scope initialized with all the service types.
	Scope *codegen.NameScope
	// ViewScope initialized with all the viewed types.
	ViewScope *codegen.NameScope
	// ProtoImports lists the import specifications for the custom
	// proto types used by the service.
	ProtoImports []*codegen.ImportSpec
	// UserTypeImports lists the import specifications for the user types
	// used by the service.
	UserTypeImports []*codegen.ImportSpec
	// contains filtered or unexported fields
}

type EndpointMethodData struct {
	*MethodData
	// ArgName is the name of the argument used to initialize the client
	// struct method field.
	ArgName string
	// StreamArgName is the name of the argument used to initialize the client
	// struct stream endpoint field when the method defines mixed results.
	//
	// It is only set when HasMixedResults is true.
	StreamArgName string
	// ClientVarName is the corresponding client struct field name.
	ClientVarName string
	// ServiceName is the name of the owner service.
	ServiceName string
	// ServiceVarName is the name of the owner service Go interface.
	ServiceVarName string
}

type EndpointsData struct {
	// Name is the service name.
	Name string
	// Description is the service description.
	Description string
	// VarName is the endpoint struct name.
	VarName string
	// ClientVarName is the client struct name.
	ClientVarName string
	// ServiceVarName is the service interface name.
	ServiceVarName string
	// Methods lists the endpoint struct methods.
	Methods []*EndpointMethodData
	// ClientInitArgs lists the arguments needed to instantiate the client.
	ClientInitArgs string
	// Schemes contains the security schemes types used by the
	// all the endpoints.
	Schemes SchemesData
	// HasServerInterceptors indicates that the service has server-side
	// interceptors.
	HasServerInterceptors bool
	// HasClientInterceptors indicates that the service has client-side
	// interceptors.
	HasClientInterceptors bool
}

type ErrorInitData struct {
	// Name is the name of the init function.
	Name string
	// Description is the error description.
	Description string
	// ErrName is the name of the error.
	ErrName string
	// TypeName is the error struct type name.
	TypeName string
	// TypeRef is the reference to the error type.
	TypeRef string
	// Temporary indicates whether the error is temporary.
	Temporary bool
	// Timeout indicates whether the error is due to timeouts.
	Timeout bool
	// Fault indicates whether the error is server-side fault.
	Fault bool
	// RemedyCode is the stable remediation code for the error if declared.
	RemedyCode string
	// SafeMessage is the safe, user-facing message for the error if declared.
	SafeMessage string
	// RetryHint is the retry or correction guidance for the error if declared.
	RetryHint string
}

type InitArgData struct {
	// Name is the argument name.
	Name string
	// Ref is the reference to the argument type.
	Ref string
}

type InitData struct {
	// Name is the name of the constructor function.
	Name string
	// Description is the function description.
	Description string
	// Args lists arguments to this function.
	Args []*InitArgData
	// ReturnTypeRef is the reference to the return type.
	ReturnTypeRef string
	// Code is the transformation code.
	Code string
	// Helpers contain the helpers used in the transformation code.
	Helpers []*codegen.TransformFunctionData
}

type InterceptorData struct {
	// Name is the name of the interceptor used in the generated code.
	Name string
	// DesignName is the name of the interceptor as defined in the design.
	DesignName string
	// Description is the description of the interceptor from the design.
	Description string
	// Methods
	Methods []*MethodInterceptorData
	// ReadPayload contains payload attributes that the interceptor can
	// read.
	ReadPayload []*AttributeData
	// WritePayload contains payload attributes that the interceptor can
	// write.
	WritePayload []*AttributeData
	// ReadResult contains result attributes that the interceptor can read.
	ReadResult []*AttributeData
	// WriteResult contains result attributes that the interceptor can
	// write.
	WriteResult []*AttributeData
	// ReadStreamingPayload contains streaming payload attributes that the interceptor can read.
	ReadStreamingPayload []*AttributeData
	// WriteStreamingPayload contains streaming payload attributes that the interceptor can write.
	WriteStreamingPayload []*AttributeData
	// ReadStreamingResult contains streaming result attributes that the interceptor can read.
	ReadStreamingResult []*AttributeData
	// WriteStreamingResult contains streaming result attributes that the interceptor can write.
	WriteStreamingResult []*AttributeData
	// HasPayloadAccess indicates that the interceptor info object has a
	// payload access interface.
	HasPayloadAccess bool
	// HasResultAccess indicates that the interceptor info object has a
	// result access interface.
	HasResultAccess bool
	// HasStreamingPayloadAccess indicates that the interceptor info object has a
	// streaming payload access interface.
	HasStreamingPayloadAccess bool
	// HasStreamingResultAccess indicates that the interceptor info object has a
	// streaming result access interface.
	HasStreamingResultAccess bool
}

type MethodData struct {
	// Name is the method name.
	Name string
	// Description is the method description.
	Description string
	// VarName is the Go method name.
	VarName string
	// Payload is the name of the payload type if any,
	Payload string
	// PayloadLoc defines the file and Go package of the payload type
	// if overridden via Meta.
	PayloadLoc *codegen.Location
	// PayloadDef is the payload type definition if any.
	PayloadDef string
	// PayloadRef is a reference to the payload type if any,
	PayloadRef string
	// PayloadDesc is the payload type description if any.
	PayloadDesc string
	// PayloadEx is an example of a valid payload value.
	PayloadEx any
	// PayloadDefault is the default value of the payload if any.
	PayloadDefault any
	// StreamingPayload is the name of the streaming payload type if any.
	StreamingPayload string
	// StreamingPayloadDef is the streaming payload type definition if any.
	StreamingPayloadDef string
	// StreamingPayloadRef is a reference to the streaming payload type if any.
	StreamingPayloadRef string
	// StreamingPayloadDesc is the streaming payload type description if any.
	StreamingPayloadDesc string
	// StreamingPayloadEx is an example of a valid streaming payload value.
	StreamingPayloadEx any
	// StreamingResult is the name of the streaming result type if any (when different from Result).
	StreamingResult string
	// StreamingResultDef is the streaming result type definition if any.
	StreamingResultDef string
	// StreamingResultRef is the reference to the streaming result type if any.
	StreamingResultRef string
	// StreamingResultDesc is the streaming result type description if any.
	StreamingResultDesc string
	// StreamingResultEx is an example of a valid streaming result value.
	StreamingResultEx any
	// Result is the name of the result type if any.
	Result string
	// ResultLoc defines the file and Go package of the result type
	// if overridden via Meta.
	ResultLoc *codegen.Location
	// ResultDef is the result type definition if any.
	ResultDef string
	// ResultRef is the reference to the result type if any.
	ResultRef string
	// ResultDesc is the result type description if any.
	ResultDesc string
	// ResultEx is an example of a valid result value.
	ResultEx any
	// Errors list the possible errors defined in the design if any.
	Errors []*ErrorInitData
	// ErrorLocs lists the file and Go package of the error type
	// if overridden via Meta indexed by error name.
	ErrorLocs map[string]*codegen.Location
	// IsJSONRPC indicates if the endpoint is a JSON-RPC endpoint.
	IsJSONRPC bool
	// IsJSONRPCSSE indicates if the JSON-RPC endpoint uses SSE transport.
	IsJSONRPCSSE bool
	// IsJSONRPCWebSocket indicates if the JSON-RPC endpoint uses WebSocket transport.
	IsJSONRPCWebSocket bool
	// Requirements contains the security requirements for the
	// method.
	Requirements RequirementsData
	// Schemes contains the security schemes types used by the
	// method.
	Schemes SchemesData
	// ServerInterceptors list the server interceptors that apply to this
	// method.
	ServerInterceptors []string
	// ClientInterceptors list the client interceptors that apply to this
	// method.
	ClientInterceptors []string
	// ViewedResult contains the data required to generate the code handling
	// views if any.
	ViewedResult *ViewedResultTypeData
	// ServerStream indicates that the service method receives a payload
	// stream or sends a result stream or both.
	ServerStream *StreamData
	// ClientStream indicates that the service method receives a result
	// stream or sends a payload result or both.
	ClientStream *StreamData
	// StreamKind is the kind of the stream (payload or result or
	// bidirectional).
	StreamKind expr.StreamKind
	// HasMixedResults indicates whether the method defines both Result and
	// StreamingResult with different types, enabling content negotiation at
	// the transport layer (e.g. JSON vs SSE over HTTP).
	HasMixedResults bool
	// SkipRequestBodyEncodeDecode is true if the method payload includes
	// the raw HTTP request body reader.
	SkipRequestBodyEncodeDecode bool
	// SkipResponseBodyEncodeDecode is true if the method result includes
	// the raw HTTP response body reader.
	SkipResponseBodyEncodeDecode bool
	// RequestStruct is the name of the data structure containing the
	// payload and request body reader when SkipRequestBodyEncodeDecode is
	// used.
	RequestStruct string
	// ResponseStruct is the name of the data structure containing the
	// result and response body reader when SkipResponseBodyEncodeDecode is
	// used.
	ResponseStruct string
	// EndpointField is the unique field name used in the generated client
	// struct to store the goa.Endpoint for this method. It is computed with a
	// scope that includes method names to avoid field/method name collisions.
	EndpointField string
	// StreamEndpointField is the unique field name used in the generated client
	// struct to store the "streaming mode" goa.Endpoint for mixed results. The
	// transport endpoint forces server streaming (e.g. sets "Accept:
	// text/event-stream") and returns the client stream interface.
	//
	// It is only set when HasMixedResults is true.
	StreamEndpointField string
}

type MethodInterceptorData struct {
	// MethodName is the name of the method.
	MethodName string
	// PayloadAccess is the name of the payload access struct.
	PayloadAccess string
	// ResultAccess is the name of the result access struct.
	ResultAccess string
	// StreamingPayloadAccess is the name of the streaming payload access struct.
	StreamingPayloadAccess string
	// StreamingResultAccess is the name of the streaming result access struct.
	StreamingResultAccess string
	// PayloadRef is the reference to the method payload type.
	PayloadRef string
	// ResultRef is the reference to the method result type.
	ResultRef string
	// StreamingPayloadRef is the reference to the streaming payload type.
	StreamingPayloadRef string
	// StreamingResultRef is the reference to the streaming result type.
	StreamingResultRef string
	// ServerStream is the stream data if the endpoint defines a server stream.
	ServerStream *StreamInterceptorData
	// ClientStream is the stream data if the endpoint defines a client stream.
	ClientStream *StreamInterceptorData
}

type ProjectedTypeData struct {
	// the projected type
	*UserTypeData
	// Validations lists the validation functions to run on the projected type.
	// If the projected type corresponds to a result type then a validation
	// function for each view is generated. For user types, only one validation
	// function is generated.
	Validations []*ValidateData
	// Projections contains the code to create a projected type based on
	// views. If the projected type corresponds to a result type, then a
	// function for each view is generated.
	Projections []*InitData
	// TypeInits contains the code to convert a projected type to its
	// corresponding service type. If the projected type corresponds to a
	// result type, then a function for each view is generated.
	TypeInits []*InitData
	// ViewsPkg is the views package name.
	ViewsPkg string
	// Views lists the views defined on the projected type.
	Views []*ViewData
}

type RequirementData struct {
	// Schemes list the requirement schemes.
	Schemes []*SchemeData
	// Scopes list the required scopes.
	Scopes []string
}

type RequirementsData []*RequirementData

type SchemeData struct {
	// Kind is the type of scheme, one of "Basic", "APIKey", "JWT"
	// or "OAuth2".
	Type string
	// SchemeName is the name of the scheme.
	SchemeName string
	// Name refers to a header or parameter name, based on In's
	// value.
	Name string
	// UsernameField is the name of the payload field that should be
	// initialized with the basic auth username if any.
	UsernameField string
	// UsernamePointer is true if the username field is a pointer.
	UsernamePointer bool
	// UsernameAttr is the name of the attribute that contains the
	// username.
	UsernameAttr string
	// UsernameRequired specifies whether the attribute that
	// contains the username is required.
	UsernameRequired bool
	// PasswordField is the name of the payload field that should be
	// initialized with the basic auth password if any.
	PasswordField string
	// PasswordPointer is true if the password field is a pointer.
	PasswordPointer bool
	// PasswordAttr is the name of the attribute that contains the
	// password.
	PasswordAttr string
	// PasswordRequired specifies whether the attribute that
	// contains the password is required.
	PasswordRequired bool
	// CredField contains the name of the payload field that should
	// be initialized with the API key, the JWT token or the OAuth2
	// access token.
	CredField string
	// CredPointer is true if the credential field is a pointer.
	CredPointer bool
	// CredRequired specifies if the key is a required attribute.
	CredRequired bool
	// KeyAttr is the name of the attribute that contains
	// the security tag (for APIKey, OAuth2, and JWT schemes).
	KeyAttr string
	// Scopes lists the scopes that apply to the scheme.
	Scopes []string
	// Flows describes the OAuth2 flows.
	Flows []*expr.FlowExpr
	// In indicates the request element that holds the credential.
	In string
}

type SchemesData []*SchemeData

type ServicesData struct {
	Root     *expr.RootExpr
	Services map[string]*Data
}

type StreamData struct {
	// Interface is the name of the stream interface.
	Interface string
	// VarName is the name of the struct type that implements the stream
	// interface.
	VarName string
	// SendName is the name of the send function.
	SendName string
	// SendDesc is the description for the send function.
	SendDesc string
	// SendWithContextName is the name of the send function with context.
	SendWithContextName string
	// SendWithContextDesc is the description for the send function with context.
	SendWithContextDesc string
	// SendTypeName is the type name sent through the stream.
	SendTypeName string
	// SendTypeRef is the reference to the type sent through the stream.
	SendTypeRef string
	// SendAndCloseName is the name of the send and close function (SSE only).
	SendAndCloseName string
	// SendAndCloseDesc is the description for the send and close function.
	SendAndCloseDesc string
	// SendAndCloseWithContextName is the name of the send and close function with context.
	SendAndCloseWithContextName string
	// SendAndCloseWithContextDesc is the description for the send and close function with context.
	SendAndCloseWithContextDesc string
	// RecvName is the name of the receive function.
	RecvName string
	// RecvDesc is the description for the recv function.
	RecvDesc string
	// RecvWithContextName is the name of the receive function with context.
	RecvWithContextName string
	// RecvWithContextDesc is the description for the recv function with context.
	RecvWithContextDesc string
	// RecvTypeName is the type name received from the stream.
	RecvTypeName string
	// RecvTypeRef is the reference to the type received from the stream.
	RecvTypeRef string
	// MustClose indicates whether the stream should implement the Close()
	// function.
	MustClose bool
	// EndpointStruct is the name of the endpoint struct that holds a payload
	// reference (if any) and the endpoint server stream.
	EndpointStruct string
	// Kind is the kind of the stream (payload, result or bidirectional).
	Kind expr.StreamKind
}

type StreamInterceptorData struct {
	// Interface is the name of the stream interface.
	Interface string
	// SendName is the name of the send function.
	SendName string
	// SendWithContextName is the name of the send function with context.
	SendWithContextName string
	// SendTypeRef is the reference to the type sent through the stream.
	SendTypeRef string
	// RecvName is the name of the recv function.
	RecvName string
	// RecvWithContextName is the name of the recv function with context.
	RecvWithContextName string
	// RecvTypeRef is the reference to the type received from the stream.
	RecvTypeRef string
	// MustClose indicates whether the stream should implement the Close()
	// function.
	MustClose bool
	// EndpointStruct is the name of the endpoint struct that holds a payload
	// reference (if any) and the endpoint server stream.
	EndpointStruct string
}

type UnionFieldData struct {
	// Name is the branch name as defined in the DSL.
	Name string
	// KindConst is the Go identifier for the kind constant of this branch.
	KindConst string
	// FieldName is the struct field name in the union.
	FieldName string
	// FieldType is the Go type used in the union struct field and public API.
	FieldType string
	// FlatFormObject is true when the branch value is object-shaped and form
	// encoding should flatten its fields under the current prefix.
	FlatFormObject bool
	// FlatFormObjectAllowsEmpty is true when the flattened object branch may be
	// selected with only the discriminator because it has no required fields.
	FlatFormObjectAllowsEmpty bool
	// EmptyValueExpr is the Go expression that initializes an empty branch
	// value when FlatFormObjectAllowsEmpty is true.
	EmptyValueExpr string
	// EmitPrimitiveAlias is true when the branch uses a generated primitive alias
	// that must be declared in the same file as the union type.
	EmitPrimitiveAlias bool
	// PrimitiveAliasType is the underlying Go type used by the generated branch
	// alias (for example "string" or "float64").
	PrimitiveAliasType string
	// TypeTag is the JSON "type" discriminator value for this branch.
	TypeTag string
}

type UnionTypeData struct {
	// Name is the Go type name of the union struct.
	Name string
	// KindName is the Go type name of the discriminator kind.
	KindName string
	// Fields describes each union branch.
	Fields []*UnionFieldData
	// Loc defines the file and Go package of the union type if overridden via
	// Meta. When nil the type is generated in the default service file.
	Loc *codegen.Location
	// TypeKey is the discriminator field name for JSON marshaling (defaults to "type").
	TypeKey string
	// ValueKey is the value field name for JSON marshaling (defaults to "value").
	ValueKey string
	// HasScalarFormBranch is true when at least one branch keeps canonical
	// type/value form encoding.
	HasScalarFormBranch bool
}

type UserTypeData struct {
	// Name is the type name.
	Name string
	// VarName is the corresponding Go type name.
	VarName string
	// Description is the type human description.
	Description string
	// Def is the type definition Go code.
	Def string
	// Ref is the reference to the type.
	Ref string
	// Loc defines the file and Go package of the type if overridden
	// via Meta.
	Loc *codegen.Location
	// Type is the underlying type.
	Type expr.UserType
	// RemedyCode is the stable remediation code for this error type if declared.
	RemedyCode string
	// SafeMessage is the safe, user-facing message for this error type if declared.
	SafeMessage string
	// RetryHint is retry or correction guidance for this error type if declared.
	RetryHint string
}

type ValidateData struct {
	// Name is the validation function name.
	Name string
	// Ref is the reference to the type on which the validation function
	// is defined.
	Ref string
	// Description is the description for the validation function.
	Description string
	// Validate is the validation code.
	Validate string
}

type ViewData struct {
	// Name is the view name.
	Name string
	// Description is the view description.
	Description string
	// Attributes is the list of attributes rendered in the view.
	Attributes []string
	// TypeVarName is the Go variable name of the type that defines the view.
	TypeVarName string
}

type ViewedResultTypeData struct {
	// the viewed result type
	*UserTypeData
	// Views lists the views defined on the viewed result type.
	Views []*ViewData
	// Validate is the validation run on the viewed result type.
	Validate *ValidateData
	// Init is the constructor code to initialize a viewed result type from
	// a result type.
	Init *InitData
	// ResultInit is the constructor code to initialize a result type
	// from the viewed result type.
	ResultInit *InitData
	// FullName is the fully qualified name of the viewed result type.
	FullName string
	// FullRef is the complete reference to the viewed result type
	// (including views package name).
	FullRef string
	// IsCollection indicates whether the viewed result type is a collection.
	IsCollection bool
	// ViewName is the view name to use to render the result type. It is set
	// only if the result type has at most one view.
	ViewName string
	// ViewsPkg is the views package name.
	ViewsPkg string
}