handlers

package
v1.2.36 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 1, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BulkDecodeVIN added in v0.8.3

func BulkDecodeVIN(m mediator.Mediator) fiber.Handler

BulkDecodeVIN godoc @Summary gets a list of decoded vins. @ID BulkDecodeVIN @Description decodes a list of VINs @Tags device-definitions @Accept json @Param vins body []string true "vin array." @Produce json @Success 200 @Failure 404 @Failure 500 @Router /bulk-decode [post]

func BulkDecodeVINCsv added in v0.9.1

func BulkDecodeVINCsv(m mediator.Mediator) fiber.Handler

BulkDecodeVINCsv godoc @Summary gets a list of decoded vins in csv format. @ID BulkDecodeVINCSV @Description decodes a list of VINs @Tags device-definitions @Accept json @Param vins body []string true "vin array." @Produce text/csv @Success 200 @Failure 404 @Failure 500 @Router /bulk-decode/csv [post]

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 added in v1.2.31

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 added in v1.2.31

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 added in v1.1.1

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 added in v1.1.1

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 added in v0.6.7

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 added in v1.0.37

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 added in v0.2.0

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 added in v0.1.26

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]

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL