protoanalysis

type Cache map[string]Packages // proto dir path-proto packages pair.

type File struct {
	// Path of the file.
	Path string

	// Dependencies is a list of imported .proto files in this package.
	Dependencies []string
}

type Files []File

type HTTPRule struct {
	// Params is a list of parameters defined in the http endpoint itself.
	Params []string

	// HasQuery indicates if there is a request query.
	HasQuery bool

	// HasBody indicates if there is a request payload.
	HasBody bool
}

type Message struct {
	// Name of the message.
	Name string

	// Path of the file where message is defined at.
	Path string

	// HighestFieldNumber is the highest field number among fields of the message
	// This allows to determine new field number when writing to proto message
	HighestFieldNumber int

	// Fields contains message's field names and types
	Fields map[string]string
}

type Package struct {
	// Name of the proto pkg.
	Name string

	// Path of the package in the fs.
	Path string

	// Files is a list of .proto files in the package.
	Files Files

	// GoImportName is the go package name of proto package.
	GoImportName string

	// Messages is a list of proto messages defined in the package.
	Messages []Message

	// Services is a list of RPC services.
	Services []Service
}

type Packages []Package

type RPCFunc struct {
	// Name of the RPC func.
	Name string

	// RequestType is the request type of RPC func.
	RequestType string

	// ReturnsType is the response type of RPC func.
	ReturnsType string

	// HTTPRules keeps info about http rules of an RPC func.
	// spec:
	//   https://github.com/googleapis/googleapis/blob/master/google/api/http.proto.
	HTTPRules []HTTPRule

	// Paginated indicates that the RPC function is using pagination.
	Paginated bool
}

type Service struct {
	// Name of the services.
	Name string

	// RPC is a list of RPC funcs of the service.
	RPCFuncs []RPCFunc
}