model

Documentation

Index

• Constants
• Variables
• func IsMajorVer(version string) bool
• func IsSemVer(version string) bool
• func ListProperties() []string
• type ClientError
• type Compatibility
• type Config
• type Error
  • func NewError(serverError *ServerError, clientError []error) *Error
  • func (err *Error) Error() string
  • func (err *Error) Messages() []string
• type Property
• type Schema
  • func (s Schema) MarshalJSON() ([]byte, error)
  • func (s *Schema) UnmarshalJSON(data []byte) error
• type SchemaId
  • func (sid *SchemaId) UnmarshalJSON(data []byte) error
• type SemVer
  • func NewSemVer(version string) (*SemVer, error)
  • func (sv *SemVer) String() string
• type ServerError
  • func (se *ServerError) Error() string
• type Subject

Constants

const (
	CompatibilityProp = "compatibility"
)

Variables

var MajorVerRegExp = regexp.MustCompile("^v(0|[1-9][0-9]*)$")

var Properties map[string]string

var SemVerRegExp = regexp.MustCompile("^v((0|[1-9][0-9]*)\\.){2}(0|[1-9][0-9]*)$")

Functions

func IsMajorVer

func IsMajorVer(version string) bool

func IsSemVer

func IsSemVer(version string) bool

IsSemVer checks if the given version string is valid form of semantic version and return true when it is valid.

func ListProperties

func ListProperties() []string

Types

type ClientError

type ClientError []error

type Compatibility

type Compatibility struct {
	IsCompatible bool `json:"is_compatible"`
}

type Config

type Config struct {
	Compatibility string `json:"compatibility"`
}

type Error

type Error struct {
	*ServerError
	ClientError
}

func NewError

func NewError(serverError *ServerError, clientError []error) *Error

func (*Error) Error

func (err *Error) Error() string

func (*Error) Messages

func (err *Error) Messages() []string

type Property

type Property struct {
	Subject  string `json:"subject"`
	Property string `json:"property"`
	Value    string `json:"value"`
}

type Schema

type Schema struct {
	Id         int64  `json:"id"`
	Subject    string `json:"subject"`
	Version    SemVer `json:"version"`
	Definition string `json:"schema"`
}

func (Schema) MarshalJSON

func (s Schema) MarshalJSON() ([]byte, error)

func (*Schema) UnmarshalJSON

func (s *Schema) UnmarshalJSON(data []byte) error

type SchemaId

type SchemaId struct {
	Id int64 `json:"id"`
}

func (*SchemaId) UnmarshalJSON

func (sid *SchemaId) UnmarshalJSON(data []byte) error

type SemVer

type SemVer struct {
	Major int
	Minor int
	Patch int
}

SemVer is the version that represents compatibility between schemas manged in typebook.

func NewSemVer

func NewSemVer(version string) (*SemVer, error)

NewSemVer create a instance of SemVer from a given version string. If a given version string is not a valid format, this returns an error. Valid form has leading "v" and following 3 integers separated by "." (e.g. v1.0.0).

func (*SemVer) String

func (sv *SemVer) String() string

type ServerError

type ServerError struct {
	ErrorCode int    `json:"error_code"`
	Message   string `json:"message"`
}

func (*ServerError) Error

func (se *ServerError) Error() string

type Subject

type Subject struct {
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
}