handlers

Documentation

Index

• func GetDeviceDefinitionAll(m mediator.Mediator) fiber.Handler
• func GetDeviceDefinitionByID(m mediator.Mediator) fiber.Handler
• func GetDeviceDefinitionByMMY(m mediator.Mediator) fiber.Handler
• func GetDeviceIntegrationsByID(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

Functions

func GetDeviceDefinitionAll

func GetDeviceDefinitionAll(m mediator.Mediator) fiber.Handler

GetDeviceDefinitionAll godoc @Summary gets all device definitions by Makes, models, and years @ID GetDeviceDefinitionByMakeModelsAndYears @Description gets a device definition @Tags device-definitions @Accept json @Produce json @Success 200 {object} queries.GetAllQueryResult @Failure 500 {object} common.ProblemDetails{} @Router /device-definitions/all [get]

func GetDeviceDefinitionByID

func GetDeviceDefinitionByID(m mediator.Mediator) fiber.Handler

GetDeviceDefinitionByID godoc @Summary gets a device definition @ID GetByID @Description gets a device definition @Tags device-definitions @Accept json @Produce json @Success 200 {object} queries.GetByIdQueryResult @Failure 404 {object} common.ProblemDetails{} @Failure 500 {object} common.ProblemDetails{} @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 GetDeviceIntegrationsByID @Description gets a specific device definition by make model and year. @Tags device-definitions @Accept json @Produce json @Success 200 {object} queries.GetByModelYearQueryResult @Failure 404 {object} common.ProblemDetails{} @Failure 500 {object} common.ProblemDetails{} @Router /device-definitions [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 @Accept json @Produce json @Success 200 {object} queries.GetByDeviceDefinitionIntegrationIdQueryResult @Failure 404 {object} common.ProblemDetails{} @Failure 500 {object} common.ProblemDetails{} @Router /device-definitions/{id}/integrations [get]

func GetDeviceTypesByID

func GetDeviceTypesByID(m mediator.Mediator) fiber.Handler

GetDeviceTypesByID godoc @Summary gets a device type. @ID GetDeviceIntegrationsByID @Description gets a devices type with attributes @Tags device-definitions @Accept json @Produce json @Success 200 {object} queries.GetDeviceTypeQueryResult @Failure 404 {object} common.ProblemDetails{} @Failure 500 {object} common.ProblemDetails{} @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 {object} queries.GetIntegrationQueryResult @Failure 404 {object} common.ProblemDetails{} @Failure 500 {object} common.ProblemDetails{} @Router /integrations/{id} [get]

func GetIntegrations

func GetIntegrations(m mediator.Mediator) fiber.Handler

GetIntegrations godoc @Summary gets list of integrations we have defined. @ID GetDeviceIntegrationsByID @Description gets list of integrations we have defined. @Tags device-definitions @Accept json @Produce json @Success 200 {object} queries.GetAllQueryResult @Failure 404 {object} common.ProblemDetails{} @Failure 500 {object} common.ProblemDetails{} @Router /integrations [get]