Documentation
¶
Index ¶
- func CreateTree(svc service.TreeService) fiber.Handler
- func DeleteTree(svc service.TreeService) fiber.Handler
- func GetAllTrees(svc service.TreeService) fiber.Handler
- func GetTreeByID(svc service.TreeService) fiber.Handler
- func GetTreeBySensorID(svc service.TreeService) fiber.Handler
- func RegisterRoutes(r fiber.Router, svc service.TreeService)
- func UpdateTree(svc service.TreeService) fiber.Handler
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateTree ¶
func CreateTree(svc service.TreeService) fiber.Handler
@Summary Create tree @Description Create tree @Id create-tree @Tags Tree @Produce json @Success 200 {object} entities.TreeResponse @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/tree [post] @Security Keycloak @Param body body entities.TreeCreateRequest true "Tree to create"
func DeleteTree ¶
func DeleteTree(svc service.TreeService) fiber.Handler
@Summary Delete tree @Description Delete tree @Id delete-tree @Tags Tree @Produce json @Success 204 @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/tree/{tree_id} [delete] @Param tree_id path string false "Tree ID" @Security Keycloak
func GetAllTrees ¶
func GetAllTrees(svc service.TreeService) fiber.Handler
@Summary Get all trees @Description Get all trees @Id get-all-trees @Tags Tree @Produce json @Success 200 {object} entities.TreeListResponse @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/tree [get] @Param page query string false "Page" @Param limit query string false "Limit" @Param age query string false "Age" @Security Keycloak
func GetTreeByID ¶
func GetTreeByID(svc service.TreeService) fiber.Handler
@Summary Get tree by ID @Description Get tree by ID @Id get-trees @Tags Tree @Produce json @Success 200 {object} entities.TreeResponse @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/tree/{tree_id} [get] @Param tree_id path string false "Tree ID" @Security Keycloak
func GetTreeBySensorID ¶ added in v1.1.0
func GetTreeBySensorID(svc service.TreeService) fiber.Handler
@Summary Get tree by sensor ID @Description Get tree by sensor ID @Id get-tree-by-sensor-id @Tags Tree Sensor @Produce json @Success 200 {object} entities.TreeResponse @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/tree/sensor/{sensor_id} [get] @Param sensor_id path string false "Sensor ID" @Security Keycloak
func RegisterRoutes ¶
func RegisterRoutes(r fiber.Router, svc service.TreeService)
func UpdateTree ¶
func UpdateTree(svc service.TreeService) fiber.Handler
@Summary Update tree @Description Update tree @Id update-tree @Tags Tree @Produce json @Success 200 {object} entities.TreeResponse @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/tree/{tree_id} [put] @Security Keycloak @Param tree_id path string false "Tree ID" @Param body body entities.TreeUpdateRequest true "Tree to update"
Types ¶
This section is empty.
Source Files