lint: fix all major issues

Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>

api/api.go

@@ -10,6 +10,7 @@ import (
 	"github.com/unistack-org/micro/v3/server"
 )
 
+// Api interface
 type Api interface {
 	// Initialise options
 	Init(...Option) error
@@ -23,23 +24,25 @@ type Api interface {
 	String() string
 }
 
+// Options holds the options
 type Options struct{}
 
+// Option func signature
 type Option func(*Options) error
 
 // Endpoint is a mapping between an RPC method and HTTP endpoint
 type Endpoint struct {
-	// RPC Method e.g. Greeter.Hello
+	// Name Greeter.Hello
 	Name string
 	// Description e.g what's this endpoint for
 	Description string
-	// API Handler e.g rpc, proxy
+	// Handler e.g rpc, proxy
 	Handler string
-	// HTTP Host e.g example.com
+	// Host e.g example.com
 	Host []string
-	// HTTP Methods e.g GET, POST
+	// Method e.g GET, POST
 	Method []string
-	// HTTP Path e.g /greeter. Expect POSIX regex
+	// Path e.g /greeter. Expect POSIX regex
 	Path []string
 	// Body destination
 	// "*" or "" - top level message value
@@ -53,9 +56,9 @@ type Endpoint struct {
 type Service struct {
 	// Name of service
 	Name string
-	// The endpoint for this service
+	// Endpoint for this service
 	Endpoint *Endpoint
-	// Versions of this service
+	// Services that provides service
 	Services []*register.Service
 }
 

api/api_test.go

@@ -5,6 +5,7 @@ import (
 	"testing"
 )
 
+//nolint:gocyclo
 func TestEncoding(t *testing.T) {
 	testData := []*Endpoint{
 		nil,

api/handler/options.go

@@ -7,9 +7,11 @@ import (
 )
 
 var (
+	// DefaultMaxRecvSize specifies max recv size for handler
 	DefaultMaxRecvSize int64 = 1024 * 1024 * 100 // 10Mb
 )
 
+// Options struct holds handler options
 type Options struct {
 	MaxRecvSize int64
 	Namespace   string
@@ -18,9 +20,10 @@ type Options struct {
 	Logger      logger.Logger
 }
 
+// Option func signature
 type Option func(o *Options)
 
-// NewOptions fills in the blanks
+// NewOptions creates new options struct and fills it
 func NewOptions(opts ...Option) Options {
 	options := Options{
 		Client:      client.DefaultClient,
@@ -54,6 +57,7 @@ func WithRouter(r router.Router) Option {
 	}
 }
 
+// WithClient specifies client to be used by the handler
 func WithClient(c client.Client) Option {
 	return func(o *Options) {
 		o.Client = c

api/resolver/host/host.go

@@ -7,11 +7,12 @@ import (
 	"github.com/unistack-org/micro/v3/api/resolver"
 )
 
-type Resolver struct {
+type hostResolver struct {
 	opts resolver.Options
 }
 
-func (r *Resolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*resolver.Endpoint, error) {
+// Resolve endpoint
+func (r *hostResolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*resolver.Endpoint, error) {
 	// parse options
 	options := resolver.NewResolveOptions(opts...)
 
@@ -24,10 +25,11 @@ func (r *Resolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*
 	}, nil
 }
 
-func (r *Resolver) String() string {
+func (r *hostResolver) String() string {
 	return "host"
 }
 
+// NewResolver creates new host api resolver
 func NewResolver(opts ...resolver.Option) resolver.Resolver {
-	return &Resolver{opts: resolver.NewOptions(opts...)}
+	return &hostResolver{opts: resolver.NewOptions(opts...)}
 }

api/resolver/path/path.go

@@ -8,10 +8,12 @@ import (
 	"github.com/unistack-org/micro/v3/api/resolver"
 )
 
+// Resolver the path resolver
 type Resolver struct {
 	opts resolver.Options
 }
 
+// Resolve resolves endpoint
 func (r *Resolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*resolver.Endpoint, error) {
 	// parse options
 	options := resolver.NewResolveOptions(opts...)
@@ -31,10 +33,12 @@ func (r *Resolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*
 	}, nil
 }
 
+// String retruns the string representation
 func (r *Resolver) String() string {
 	return "path"
 }
 
+// NewResolver returns new path resolver
 func NewResolver(opts ...resolver.Option) resolver.Resolver {
 	return &Resolver{opts: resolver.NewOptions(opts...)}
 }

api/resolver/subdomain/subdomain.go

@@ -12,17 +12,19 @@ import (
 	"golang.org/x/net/publicsuffix"
 )
 
+// NewResolver creates new subdomain api resolver
 func NewResolver(parent resolver.Resolver, opts ...resolver.Option) resolver.Resolver {
 	options := resolver.NewOptions(opts...)
-	return &Resolver{options, parent}
+	return &subdomainResolver{options, parent}
 }
 
-type Resolver struct {
+type subdomainResolver struct {
 	opts resolver.Options
 	resolver.Resolver
 }
 
-func (r *Resolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*resolver.Endpoint, error) {
+// Resolve resolve endpoint based on subdomain
+func (r *subdomainResolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*resolver.Endpoint, error) {
 	if dom := r.Domain(req); len(dom) > 0 {
 		opts = append(opts, resolver.Domain(dom))
 	}
@@ -30,7 +32,8 @@ func (r *Resolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*
 	return r.Resolver.Resolve(req, opts...)
 }
 
-func (r *Resolver) Domain(req *http.Request) string {
+// Domain returns domain
+func (r *subdomainResolver) Domain(req *http.Request) string {
 	// determine the host, e.g. foobar.m3o.app
 	host := req.URL.Hostname()
 	if len(host) == 0 {
@@ -82,6 +85,6 @@ func (r *Resolver) Domain(req *http.Request) string {
 	return strings.Join(comps, "-")
 }
 
-func (r *Resolver) String() string {
+func (r *subdomainResolver) String() string {
 	return "subdomain"
 }

api/resolver/vpath/vpath.go

@@ -10,11 +10,12 @@ import (
 	"github.com/unistack-org/micro/v3/api/resolver"
 )
 
+// NewResolver creates new vpath api resolver
 func NewResolver(opts ...resolver.Option) resolver.Resolver {
-	return &Resolver{opts: resolver.NewOptions(opts...)}
+	return &vpathResolver{opts: resolver.NewOptions(opts...)}
 }
 
-type Resolver struct {
+type vpathResolver struct {
 	opts resolver.Options
 }
 
@@ -22,7 +23,8 @@ var (
 	re = regexp.MustCompile("^v[0-9]+$")
 )
 
-func (r *Resolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*resolver.Endpoint, error) {
+// Resolve endpoint
+func (r *vpathResolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*resolver.Endpoint, error) {
 	if req.URL.Path == "/" {
 		return nil, errors.New("unknown name")
 	}
@@ -60,12 +62,12 @@ func (r *Resolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*
 	}, nil
 }
 
-func (r *Resolver) String() string {
-	return "path"
+func (r *vpathResolver) String() string {
+	return "vpath"
 }
 
 // withPrefix transforms "foo" into "go.micro.api.foo"
-func (r *Resolver) withPrefix(parts ...string) string {
+func (r *vpathResolver) withPrefix(parts ...string) string {
 	p := r.opts.ServicePrefix
 	if len(p) > 0 {
 		parts = append([]string{p}, parts...)

api/router/options.go

@@ -9,6 +9,7 @@ import (
 	"github.com/unistack-org/micro/v3/register"
 )
 
+// Options holds the options for api router
 type Options struct {
 	Handler  string
 	Register register.Register
@@ -17,8 +18,10 @@ type Options struct {
 	Context  context.Context
 }
 
+// Option func signature
 type Option func(o *Options)
 
+// NewOptions returns options struct filled by opts
 func NewOptions(opts ...Option) Options {
 	options := Options{
 		Context: context.Background(),

api/router/router.go

@@ -8,6 +8,7 @@ import (
 )
 
 var (
+	// DefaultRouter contains default router implementation
 	DefaultRouter Router
 )