handlers

Documentation

Index

• func DecodeVIN(m mediator.Mediator) fiber.Handler
• func GetCompatibilityR1Sheet(m mediator.Mediator) fiber.Handler
• func GetDeviceDefinitionAll(m mediator.Mediator) fiber.Handler
• func GetDeviceDefinitionAutocomplete(m mediator.Mediator) fiber.Handler
• func GetDeviceDefinitionByID(m mediator.Mediator) fiber.Handler
• func GetDeviceDefinitionByMMY(m mediator.Mediator) fiber.Handler
• func GetDeviceDefinitionSearch(m mediator.Mediator) fiber.Handler
• func GetDeviceDefinitionV2All(m mediator.Mediator) fiber.Handler
• func GetDeviceDefinitionV2ByID(m mediator.Mediator) fiber.Handler
• func GetDeviceIntegrationsByID(m mediator.Mediator) fiber.Handler
• func GetDeviceMakes(m mediator.Mediator) fiber.Handler
• func GetDeviceTypes(m mediator.Mediator) fiber.Handler
• func GetDeviceTypesByID(m mediator.Mediator) fiber.Handler
• func GetIntegrationByID(m mediator.Mediator) fiber.Handler
• func GetIntegrations(m mediator.Mediator) fiber.Handler
• func GetR1CompatibilitySearch(m mediator.Mediator) fiber.Handler
• func GetSmartcarManufacturers() fiber.Handler
• type DecodeVINRequest
• type DecodeVINResponse

Functions

func DecodeVIN

func DecodeVIN(m mediator.Mediator) fiber.Handler

DecodeVIN godoc @Summary returns device definition id corresponding to a given vin @ID DecodeVIN @Description decode a vin @Tags device-definitions @Produce json @Accept json @Param decodeRequest body DecodeVINRequest true "Decode VIN request" @Success 200 {object} DecodeVINResponse "Response with definition ID. @Failure 404 @Failure 500 @Security BearerAuth @Router /device-definitions/decode-vin [post]

func GetCompatibilityR1Sheet

func GetCompatibilityR1Sheet(m mediator.Mediator) fiber.Handler

GetCompatibilityR1Sheet godoc @Summary gets r1 MMY compatibility google sheet in JSON form @ID GetCompatibilityR1Sheet @Description gets r1 MMY compatibility google sheet in JSON form. returns an array of below objects @Tags device-definitions @Produce json @Success 200 {object} queries.CompatibilitySheetRow @Failure 500 @Router /compatibility/r1-sheet [get]

func GetDeviceDefinitionAll

func GetDeviceDefinitionAll(m mediator.Mediator) fiber.Handler

GetDeviceDefinitionAll godoc @Summary gets all device definitions by Makes, models, and years @ID GetDeviceDefinitionAll @Description gets a device definition @Tags device-definitions @Accept json @Produce json @Success 200 @Failure 500 @Router /device-definitions/all [get]

func GetDeviceDefinitionAutocomplete

func GetDeviceDefinitionAutocomplete(m mediator.Mediator) fiber.Handler

GetDeviceDefinitionAutocomplete godoc @Summary gets device definitions autocomplete @ID GetDeviceDefinitionAutocomplete @Description gets a device definition Autocomplete @Tags device-definitions @Param query query string true "query filter" @Accept json @Produce json @Success 200 {object} queries.GetAllDeviceDefinitionByAutocompleteQueryResult @Failure 500 @Router /device-definitions/autocomplete [get]

func GetDeviceDefinitionByID

func GetDeviceDefinitionByID(m mediator.Mediator) fiber.Handler

GetDeviceDefinitionByID godoc @Summary gets a device definition @ID GetDeviceDefinitionByID @Description gets a device definition @Tags device-definitions @Param id path string true "device definition id" @Produce json @Success 200 {object} models.GetDeviceDefinitionQueryResult @Failure 404 @Failure 500 @Router /device-definitions/{id} [get]

func GetDeviceDefinitionByMMY

func GetDeviceDefinitionByMMY(m mediator.Mediator) fiber.Handler

GetDeviceDefinitionByMMY godoc @Summary gets a specific device definition by make model and year. @ID GetDeviceDefinitionByMMY @Description gets a specific device definition by make model and year. @Tags device-definitions @Param make query string true "make" @Param model query string true "model" @Param year query number true "year" @Produce json @Success 200 {object} models.GetDeviceDefinitionQueryResult @Failure 404 @Failure 500 @Router /device-definitions [get]

func GetDeviceDefinitionSearch

func GetDeviceDefinitionSearch(m mediator.Mediator) fiber.Handler

GetDeviceDefinitionSearch godoc @Summary gets device definitions by search filter @ID GetDeviceDefinitionSearch @Description gets a device definition by search filter @Tags device-definitions @Param query query string true "query filter" @Param makeSlug query string false "make Slug" @Param modelSlug query string false "model Slug" @Param year query number false "year" @Param page query number false "page" @Param pageSize query number false "pageSize" @Accept json @Produce json @Success 200 {object} queries.GetAllDeviceDefinitionBySearchQueryResult @Failure 500 @Router /device-definitions/search [get]

func GetDeviceDefinitionV2All

func GetDeviceDefinitionV2All(m mediator.Mediator) fiber.Handler

GetDeviceDefinitionV2All godoc @Summary gets all device definitions by Makes, models, and years @ID GetDeviceDefinitionV2All @Description gets a device definition @Param make path string true "device make name" @Tags device-definitions @Accept json @Produce json @Success 200 @Failure 500 @Router /v2/device-definitions/{make}/all [get]

func GetDeviceDefinitionV2ByID

func GetDeviceDefinitionV2ByID(m mediator.Mediator) fiber.Handler

GetDeviceDefinitionV2ByID godoc @Summary gets a device definition @ID GetDeviceDefinitionV2ByID @Description gets a device definition @Tags device-definitions @Param make path string true "device make name" @Param id path string true "device definition id" @Produce json @Success 200 {object} models.GetDeviceDefinitionQueryResult @Failure 404 @Failure 500 @Router /v2/device-definitions/{make}/{id} [get]

func GetDeviceIntegrationsByID

func GetDeviceIntegrationsByID(m mediator.Mediator) fiber.Handler

GetDeviceIntegrationsByID godoc @Summary gets all the available integrations for a device definition. @ID GetDeviceIntegrationsByID @Description gets all the available integrations for a device definition. Includes the capabilities of the device with the integration @Tags device-definitions @Param id path string true "device definition id" @Produce json @Success 200 @Failure 404 @Failure 500 @Router /device-definitions/{id}/integrations [get]

func GetDeviceMakes

func GetDeviceMakes(m mediator.Mediator) fiber.Handler

GetDeviceMakes godoc @Summary gets all device makes @ID GetDeviceMakes @Description gets all device makes @Tags device-definitions @Produce json @Success 200 {object} grpc.GetDeviceMakeResponse @Failure 500 @Router /device-makes [get]

func GetDeviceTypes

func GetDeviceTypes(m mediator.Mediator) fiber.Handler

GetDeviceTypes godoc @Summary gets a device type. @ID GetDeviceTypes @Description gets a devices type @Tags device-definitions @Produce json @Success 200 @Failure 500 @Router /device-types [get]

func GetDeviceTypesByID

func GetDeviceTypesByID(m mediator.Mediator) fiber.Handler

GetDeviceTypesByID godoc @Summary gets a device type. @ID GetDeviceTypesByID @Description gets a devices type with attributes @Tags device-definitions @Param id path string true "device type id" @Produce json @Success 200 @Failure 404 @Failure 500 @Router /device-types/{id} [get]

func GetIntegrationByID

func GetIntegrationByID(m mediator.Mediator) fiber.Handler

GetIntegrationByID godoc @Summary gets integration by id. @ID GetIntegrationByID @Description gets integration by id. @Tags device-definitions @Accept json @Produce json @Success 200 @Failure 404 @Failure 500 @Router /integrations/{id} [get]

func GetIntegrations

func GetIntegrations(m mediator.Mediator) fiber.Handler

GetIntegrations godoc @Summary gets list of integrations we have defined. @ID GetIntegrations @Description gets list of integrations we have defined. @Tags device-definitions @Produce json @Success 200 @Failure 404 @Failure 500 @Router /integrations [get]

func GetR1CompatibilitySearch

func GetR1CompatibilitySearch(m mediator.Mediator) fiber.Handler

GetR1CompatibilitySearch godoc @Summary gets r1 MMY compatibility by search filter @ID GetR1CompatibilitySearch @Description gets r1 compatibility search by filter @Tags device-definitions @Param query query string true "query filter" @Param page query number false "page" @Param pageSize query number false "pageSize" @Accept json @Produce json @Success 200 {object} queries.GetR1CompatibilitySearchQueryResult @Failure 500 @Router /device-definitions/search-r1 [get]

func GetSmartcarManufacturers

func GetSmartcarManufacturers() fiber.Handler

GetSmartcarManufacturers godoc @Summary gets all supported manufacturers for the smartcar external integration @ID GetSmartcarManufacturers @Description gets manufacturers supported by smartcar @Tags device-definitions @Produce json @Success 200 @Failure 500 @Router /manufacturers/integrations/smartcar [get]

Types

type DecodeVINRequest

type DecodeVINRequest struct {
	VIN string `json:"vin"`
	// 3 letter ISO
	CountryCode string `json:"countryCode"`
}

type DecodeVINResponse

type DecodeVINResponse struct {
	// new name slug based id, can use this to query identity-api
	DeviceDefinitionID string `json:"deviceDefinitionId"`
	// old ksuid based device def id
	LegacyID string `json:"legacyId"`
	// if a new device definition was created, the tableland transaction hash from the insert statement. Check this has completed before querying the ID
	NewTransactionHash string `json:"newTransactionHash"`
}