wateringplan

package
v1.2.1 Latest Latest
Warning

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

Go to latest
Published: May 1, 2025 License: AGPL-3.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreatePreviewRoute

func CreatePreviewRoute(svc service.WateringPlanService) fiber.Handler

@Summary Generate preview route @Description Generate preview route @Tags Watering Plan @Produce json @Accept json @Success 200 {object} entities.GeoJSON @Failure 400 {object} HTTPError @Failure 500 {object} HTTPError @Param body body entities.RouteRequest true "Route Request" @Router /v1/watering-plan/route/preview [post] @Security Keycloak

func CreateWateringPlan

func CreateWateringPlan(svc service.WateringPlanService) fiber.Handler

@Summary Create watering plan @Description Create watering plan @Id create-watering-plan @Tags Watering Plan @Produce json @Success 201 {object} entities.WateringPlanResponse @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/watering-plan [post] @Param body body entities.WateringPlanCreateRequest true "Watering Plan Create Request" @Security Keycloak

func DeleteWateringPlan

func DeleteWateringPlan(svc service.WateringPlanService) fiber.Handler

@Summary Delete watering plan @Description Delete watering plan @Id delete-watering-plan @Tags Watering Plan @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/watering-plan/{id} [delete] @Param id path int true "Watering Plan ID" @Security Keycloak

func GetAllWateringPlans

func GetAllWateringPlans(svc service.WateringPlanService) fiber.Handler

@Summary Get all watering plans @Description Get all watering plans @Id get-all-watering-plans @Tags Watering Plan @Produce json @Success 200 {object} entities.WateringPlanListResponse @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/watering-plan [get] @Param page query int false "Page" @Param limit query int false "Limit" @Param provider query string false "Provider" @Security Keycloak

func GetGpxFile

func GetGpxFile(svc service.WateringPlanService) fiber.Handler

@Summary Generate route @Description Generate route @Tags Watering Plan @Produce application/gpx+xml @Produce json @Accept json @Success 200 {file} application/gpx+xml @Failure 400 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/watering-plan/route/gpx/{gpx_name} [get] @Param gpx_name path string true "gpx file name" @Security Keycloak

func GetWateringPlanByID

func GetWateringPlanByID(svc service.WateringPlanService) fiber.Handler

@Summary Get watering plan by ID @Description Get watering plan by ID @Id get-watering-plan-by-id @Tags Watering Plan @Produce json @Success 200 {object} entities.WateringPlanResponse @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/watering-plan/{id} [get] @Param id path int true "Watering Plan ID" @Security Keycloak

func RegisterRoutes

func RegisterRoutes(r fiber.Router, svc service.WateringPlanService)

func UpdateWateringPlan

func UpdateWateringPlan(svc service.WateringPlanService) fiber.Handler

@Summary Update watering plan @Description Update watering plan @Id update-watering-plan @Tags Watering Plan @Produce json @Success 200 {object} entities.WateringPlanResponse @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/watering-plan/{id} [put] @Param id path string true "Watering Plan ID" @Param body body entities.WateringPlanUpdateRequest true "Watering Plan Update Request" @Security Keycloak

Types

This section is empty.

Jump to

Keyboard shortcuts

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