Documentation
¶
Index ¶
- func ArchiveVehicle(svc service.VehicleService) fiber.Handler
- func CreateVehicle(svc service.VehicleService) fiber.Handler
- func DeleteVehicle(svc service.VehicleService) fiber.Handler
- func GetAllVehicles(svc service.VehicleService) fiber.Handler
- func GetArchiveVehicles(svc service.VehicleService) fiber.Handler
- func GetVehicleByID(svc service.VehicleService) fiber.Handler
- func GetVehicleByPlate(svc service.VehicleService) fiber.Handler
- func RegisterRoutes(r fiber.Router, svc service.VehicleService)
- func UpdateVehicle(svc service.VehicleService) fiber.Handler
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ArchiveVehicle ¶
func ArchiveVehicle(svc service.VehicleService) fiber.Handler
@Summary Archive vehicle @Description Archive vehicle @Id archive-vehicle @Tags Vehicle @Produce json @Success 204 @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 409 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/vehicle/archive/{id} [post] @Param id path int true "Vehicle ID" @Security Keycloak
func CreateVehicle ¶
func CreateVehicle(svc service.VehicleService) fiber.Handler
@Summary Create vehicle @Description Create vehicle @Id create-vehicle @Tags Vehicle @Produce json @Success 201 {object} entities.VehicleResponse @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/vehicle [post] @Param body body entities.VehicleCreateRequest true "Vehicle Create Request" @Security Keycloak
func DeleteVehicle ¶
func DeleteVehicle(svc service.VehicleService) fiber.Handler
@Summary Delete vehicle @Description Delete vehicle @Id delete-vehicle @Tags Vehicle @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/vehicle/{id} [delete] @Param id path int true "Vehicle ID" @Security Keycloak
func GetAllVehicles ¶
func GetAllVehicles(svc service.VehicleService) fiber.Handler
@Summary Get all vehicles @Description Get all vehicles @Id get-all-vehicles @Tags Vehicle @Produce json @Success 200 {object} entities.VehicleListResponse @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/vehicle [get] @Param page query int false "Page" @Param limit query int false "Limit" @Param type query string false "Vehicle Type" @Param provider query string false "Provider" @Param archived query bool false "With archived vehicles" @Security Keycloak
func GetArchiveVehicles ¶
func GetArchiveVehicles(svc service.VehicleService) fiber.Handler
@Summary Get archived vehicle @Description Get archived vehicle @Id get-archive-vehicle @Tags Vehicle @Produce json @Success 200 {object} []entities.VehicleResponse @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/vehicle/archive [get] @Security Keycloak
func GetVehicleByID ¶
func GetVehicleByID(svc service.VehicleService) fiber.Handler
@Summary Get vehicle by ID @Description Get vehicle by ID @Id get-vehicle-by-id @Tags Vehicle @Produce json @Success 200 {object} entities.VehicleResponse @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/vehicle/{id} [get] @Param id path int true "Vehicle ID" @Security Keycloak
func GetVehicleByPlate ¶
func GetVehicleByPlate(svc service.VehicleService) fiber.Handler
@Summary Get vehicle by plate @Description Get vehicle by plate @Id get-vehicle-by-plate @Tags Vehicle @Produce json @Success 200 {object} entities.VehicleResponse @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/vehicle/plate/{plate} [get] @Param plate path string true "Vehicle plate number" @Security Keycloak
func RegisterRoutes ¶
func RegisterRoutes(r fiber.Router, svc service.VehicleService)
func UpdateVehicle ¶
func UpdateVehicle(svc service.VehicleService) fiber.Handler
@Summary Update vehicle @Description Update vehicle @Id update-vehicle @Tags Vehicle @Produce json @Success 200 {object} entities.VehicleResponse @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/vehicle/{id} [put] @Param id path string true "Vehicle ID" @Param body body entities.VehicleUpdateRequest true "Vehicle Update Request" @Security Keycloak
Types ¶
This section is empty.