Documentation
¶
Index ¶
- func AddTreeImage(_ service.TreeService) fiber.Handler
- func AddTreeSensor(_ service.TreeService) fiber.Handler
- 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 GetTreeImages(_ service.TreeService) fiber.Handler
- func GetTreeSensor(_ service.TreeService) fiber.Handler
- func RegisterRoutes(svc service.TreeService) *fiber.App
- func RemoveTreeImage(_ service.TreeService) fiber.Handler
- func RemoveTreeSensor(_ service.TreeService) fiber.Handler
- func UpdateTree(svc service.TreeService) fiber.Handler
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddTreeImage ¶
func AddTreeImage(_ service.TreeService) fiber.Handler
@Summary Add images to a tree @Description Add images to a tree @Id add-images-to-tree @Tags Tree Images @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}/images [post] @Param tree_id path string false "Tree ID" @Param body body entities.TreeAddImagesRequest true "Images to add" @Security Keycloak
func AddTreeSensor ¶
func AddTreeSensor(_ service.TreeService) fiber.Handler
@Summary Add sensor to a tree @Description Add sensor to a tree @Id add-sensor-to-tree @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/{tree_id}/sensor [post] @Param tree_id path string false "Tree ID" @Param body body entities.TreeAddSensorRequest true "Sensor to add" @Security Keycloak
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" @Param treecluster_id query string false "Tree Cluster ID" @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 GetTreeImages ¶
func GetTreeImages(_ service.TreeService) fiber.Handler
@Summary Get images of a tree @Description Get images of a tree @Id get-tree-images @Tags Tree Images @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}/images [get] @Param tree_id path string false "Tree ID" @Param page query string false "Page" @Param limit query string false "Limit" @Security Keycloak
func GetTreeSensor ¶
func GetTreeSensor(_ service.TreeService) fiber.Handler
@Summary Get sensor of a tree @Description Get sensor of a tree @Id get-tree-sensor @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/{tree_id}/sensor [get] @Param tree_id path string false "Tree ID" @Security Keycloak
func RegisterRoutes ¶
func RegisterRoutes(svc service.TreeService) *fiber.App
func RemoveTreeImage ¶
func RemoveTreeImage(_ service.TreeService) fiber.Handler
@Summary Remove image from a tree @Description Remove image from a tree @Id remove-image-from-tree @Tags Tree Images @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}/images/{image_id} [delete] @Param tree_id path string false "Tree ID" @Param image_id path string false "Image ID" @Security Keycloak
func RemoveTreeSensor ¶
func RemoveTreeSensor(_ service.TreeService) fiber.Handler
@Summary Remove sensor from a tree @Description Remove sensor from a tree @Id remove-sensor-from-tree @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/{tree_id}/sensor/{sensor_id} [delete] @Param tree_id path string false "Tree ID" @Param sensor_id path string false "Sensor ID" @Security Keycloak
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