apiserver

Documentation

Index

• func Start(conf *config.Settings, addr string) error
• type Result
  • func NewResult(store store.Store, vin *govin.VIN) *Result
• type VIN
• type Vehicle

Functions

func Start

func Start(conf *config.Settings, addr string) error

Start starts http server on the specified addr.

Types

type Result

type Result struct {
	VIN     VIN     `json:"vin"`
	Vehicle Vehicle `json:"vehicle"`
}

Result is a union of information about vin-code and decoded vehicle.

func NewResult

func NewResult(store store.Store, vin *govin.VIN) *Result

type VIN

type VIN struct {
	WMI string `json:"wmi"` // World manufacturer identifier.
	VDS string `json:"vds"` // Vehicle descriptor section.
	VIS string `json:"vis"` // Vehicle identifier section.
}

VIN represents detailed information about the VIN code.

type Vehicle

type Vehicle struct {
	Manufacturer string       `json:"manufacturer"`
	Country      string       `json:"country"`
	Year         *uint        `json:"year,omitempty"`
	Region       govin.Region `json:"region"`
	Check        bool         `json:"check"`
}

Vehicle represent information about the decoded vehicle.