api/api.go

@@ -34,20 +34,20 @@ type Option func(*Options) error
 type Endpoint struct {
 	// Name Greeter.Hello
 	Name string
-	// Description e.g what's this endpoint for
+	// Desciption for endpoint
 	Description string
 	// Handler e.g rpc, proxy
 	Handler string
+	// Body destination
+	// "*" or "" - top level message value
+	// "string" - inner message value
+	Body string
 	// Host e.g example.com
 	Host []string
 	// Method e.g GET, POST
 	Method []string
 	// Path e.g /greeter. Expect POSIX regex
 	Path []string
-	// Body destination
-	// "*" or "" - top level message value
-	// "string" - inner message value
-	Body string
 	// Stream flag
 	Stream bool
 }

api/handler/options.go

@@ -13,11 +13,11 @@ var (
 
 // Options struct holds handler options
 type Options struct {
-	MaxRecvSize int64
-	Namespace   string
 	Router      router.Router
 	Client      client.Client
 	Logger      logger.Logger
+	Namespace   string
+	MaxRecvSize int64
 }
 
 // Option func signature

api/resolver/options.go

@@ -8,9 +8,12 @@ import (
 
 // Options struct
 type Options struct {
-	Handler       string
+	// Context is for external defined options
+	Context context.Context
+	// Handler name
+	Handler string
+	// ServicePrefix is the prefix
 	ServicePrefix string
-	Context       context.Context
 }
 
 // Option func

api/router/options.go

@@ -11,11 +11,16 @@ import (
 
 // Options holds the options for api router
 type Options struct {
-	Handler  string
+	// Register for service lookup
 	Register register.Register
+	// Resolver to use
 	Resolver resolver.Resolver
-	Logger   logger.Logger
-	Context  context.Context
+	// Logger micro logger
+	Logger logger.Logger
+	// Context is for external options
+	Context context.Context
+	// Handler name
+	Handler string
 }
 
 // Option func signature

auth/auth.go

@@ -53,30 +53,30 @@ type Auth interface {
 
 // Account provided by an auth provider
 type Account struct {
-	// ID of the account e.g. email
+	// Metadata any other associated metadata
+	Metadata metadata.Metadata `json:"metadata"`
+	// ID of the account e.g. email or uuid
 	ID string `json:"id"`
 	// Type of the account, e.g. service
 	Type string `json:"type"`
 	// Issuer of the account
 	Issuer string `json:"issuer"`
-	// Any other associated metadata
-	Metadata metadata.Metadata `json:"metadata"`
-	// Scopes the account has access to
-	Scopes []string `json:"scopes"`
 	// Secret for the account, e.g. the password
 	Secret string `json:"secret"`
+	// Scopes the account has access to
+	Scopes []string `json:"scopes"`
 }
 
 // Token can be short or long lived
 type Token struct {
-	// The token to be used for accessing resources
-	AccessToken string `json:"access_token"`
-	// RefreshToken to be used to generate a new token
-	RefreshToken string `json:"refresh_token"`
 	// Time of token creation
 	Created time.Time `json:"created"`
 	// Time of token expiry
 	Expiry time.Time `json:"expiry"`
+	// The token to be used for accessing resources
+	AccessToken string `json:"access_token"`
+	// RefreshToken to be used to generate a new token
+	RefreshToken string `json:"refresh_token"`
 }
 
 // Expired returns a boolean indicating if the token needs to be refreshed
@@ -106,17 +106,15 @@ const (
 
 // Rule is used to verify access to a resource
 type Rule struct {
-	// ID of the rule, e.g. "public"
+	// Resource that rule belongs to
+	Resource *Resource
+	// ID of the rule
 	ID string
-	// Scope the rule requires, a blank scope indicates open to the public and * indicates the rule
-	// applies to any valid account
+	// Scope of the rule
 	Scope string
-	// Resource the rule applies to
-	Resource *Resource
-	// Access determines if the rule grants or denies access to the resource
+	// Access flag allow/deny
 	Access Access
-	// Priority the rule should take when verifying a request, the higher the value the sooner the
-	// rule will be applied
+	// Priority holds the rule priority
 	Priority int32
 }
 

auth/options.go

@@ -26,33 +26,34 @@ func NewOptions(opts ...Option) Options {
 
 // Options struct holds auth options
 type Options struct {
-	Name string
-	// Issuer of the service's account
-	Issuer string
-	// ID is the services auth ID
-	ID string
-	// Secret is used to authenticate the service
-	Secret string
+	// Context holds the external options
+	Context context.Context
+	// Meter used for metrics
+	Meter meter.Meter
+	// Logger used for logging
+	Logger logger.Logger
+	// Tracer used for tracing
+	Tracer tracer.Tracer
+	// Store used for stre data
+	Store store.Store
 	// Token is the services token used to authenticate itself
 	Token *Token
-	// PublicKey for decoding JWTs
-	PublicKey string
-	// PrivateKey for encoding JWTs
-	PrivateKey string
 	// LoginURL is the relative url path where a user can login
 	LoginURL string
-	// Store to back auth
-	Store store.Store
+	// PrivateKey for encoding JWTs
+	PrivateKey string
+	// PublicKey for decoding JWTs
+	PublicKey string
+	// Secret is used to authenticate the service
+	Secret string
+	// ID is the services auth ID
+	ID string
+	// Issuer of the service's account
+	Issuer string
+	// Name holds the auth name
+	Name string
 	// Addrs sets the addresses of auth
 	Addrs []string
-	// Logger sets the logger
-	Logger logger.Logger
-	// Meter sets tht meter
-	Meter meter.Meter
-	// Tracer
-	Tracer tracer.Tracer
-	// Context to store other options
-	Context context.Context
 }
 
 // Option func
@@ -124,18 +125,12 @@ func LoginURL(url string) Option {
 
 // GenerateOptions struct
 type GenerateOptions struct {
-	// Metadata associated with the account
 	Metadata metadata.Metadata
-	// Scopes the account has access too
-	Scopes []string
-	// Provider of the account, e.g. oauth
 	Provider string
-	// Type of the account, e.g. user
-	Type string
-	// Secret used to authenticate the account
-	Secret string
-	// Issuer of the account, e.g. micro
-	Issuer string
+	Type     string
+	Secret   string
+	Issuer   string
+	Scopes   []string
 }
 
 // GenerateOption func
@@ -194,16 +189,11 @@ func NewGenerateOptions(opts ...GenerateOption) GenerateOptions {
 
 // TokenOptions struct
 type TokenOptions struct {
-	// ID for the account
-	ID string
-	// Secret for the account
-	Secret string
-	// RefreshToken is used to refesh a token
+	ID           string
+	Secret       string
 	RefreshToken string
-	// Expiry is the time the token should live for
-	Expiry time.Duration
-	// Issuer of the account
-	Issuer string
+	Issuer       string
+	Expiry       time.Duration
 }
 
 // TokenOption func

broker/memory.go

@@ -13,28 +13,27 @@ import (
 )
 
 type memoryBroker struct {
-	opts Options
-
-	addr string
-	sync.RWMutex
-	connected   bool
+	opts        Options
 	Subscribers map[string][]*memorySubscriber
+	addr        string
+	sync.RWMutex
+	connected bool
 }
 
 type memoryEvent struct {
 	opts    Options
-	topic   string
 	err     error
 	message interface{}
+	topic   string
 }
 
 type memorySubscriber struct {
-	id      string
-	topic   string
-	exit    chan bool
-	handler Handler
 	opts    SubscribeOptions
 	ctx     context.Context
+	exit    chan bool
+	handler Handler
+	id      string
+	topic   string
 }
 
 func (m *memoryBroker) Options() Options {

broker/options.go

@@ -13,25 +13,26 @@ import (
 
 // Options struct
 type Options struct {
-	Name string
-	// Addrs useed by broker
-	Addrs []string
-	// ErrorHandler executed when errors occur processing messages
-	ErrorHandler Handler
-	// Codec used to marshal/unmarshal messages
+	// Tracer used for tracing
+	Tracer tracer.Tracer
+	// Register can be used for clustering
+	Register register.Register
+	// Codec holds the codec for marshal/unmarshal
 	Codec codec.Codec
-	// Logger the used logger
+	// Logger used for logging
 	Logger logger.Logger
-	// Meter the used for metrics
+	// Meter used for metrics
 	Meter meter.Meter
-	// Tracer used for trace
-	Tracer tracer.Tracer
-	// TLSConfig for secure communication
-	TLSConfig *tls.Config
-	// Register used for clustering
-	Register register.Register
-	// Context is used for non default options
+	// Context holds external options
 	Context context.Context
+	// TLSConfig holds tls.TLSConfig options
+	TLSConfig *tls.Config
+	// ErrorHandler used when broker can't unmarshal incoming message
+	ErrorHandler Handler
+	// Name holds the broker name
+	Name string
+	// Addrs holds the broker address
+	Addrs []string
 }
 
 // NewOptions create new Options
@@ -59,10 +60,10 @@ func Context(ctx context.Context) Option {
 
 // PublishOptions struct
 type PublishOptions struct {
-	// BodyOnly says that only body of the message must be published
-	BodyOnly bool
-	// Context for non default options
+	// Context holds external options
 	Context context.Context
+	// BodyOnly flag says the message contains raw body bytes
+	BodyOnly bool
 }
 
 // NewPublishOptions creates PublishOptions struct
@@ -80,22 +81,16 @@ func NewPublishOptions(opts ...PublishOption) PublishOptions {
 
 // SubscribeOptions struct
 type SubscribeOptions struct {
-	// AutoAck ack messages if handler returns nil err
-	AutoAck bool
-
-	// ErrorHandler executed when errors occur processing messages
+	// Context holds external options
+	Context context.Context
+	// ErrorHandler used when broker can't unmarshal incoming message
 	ErrorHandler Handler
-
-	// Group for subscriber, Subscribers with the same group name
-	// will create a shared subscription where each
-	// receives a subset of messages.
+	// Group holds consumer group
 	Group string
-
-	// BodyOnly says that consumed only body of the message
+	// AutoAck flag specifies auto ack of incoming message when no error happens
+	AutoAck bool
+	// BodyOnly flag specifies that message contains only body bytes without header
 	BodyOnly bool
-
-	// Context is used for non default options
-	Context context.Context
 }
 
 // Option func

build/build.go

@@ -21,12 +21,12 @@ type Source struct {
 
 // Package is packaged format for source
 type Package struct {
+	// Source of the package
+	Source *Source
 	// Name of the package
 	Name string
 	// Location of the package
 	Path string
 	// Type of package e.g tarball, binary, docker
 	Type string
-	// Source of the package
-	Source *Source
 }

client/noop.go

@@ -31,12 +31,12 @@ type noopMessage struct {
 }
 
 type noopRequest struct {
+	body        interface{}
+	codec       codec.Codec
 	service     string
 	method      string
 	endpoint    string
 	contentType string
-	body        interface{}
-	codec       codec.Codec
 	stream      bool
 }