Skip to content
Snippets Groups Projects
Commit c36f4516 authored by Tucker Gary Siegel's avatar Tucker Gary Siegel
Browse files

Merge branch 'oob-fix' into 'develop'

update swagger documentation

See merge request !23
parents c20fb3fa 82df0758
No related branches found
No related tags found
1 merge request!23update swagger documentation
......@@ -12,19 +12,25 @@ import (
var GetGddValues = services.GetGddValues
// GetDailyGdd godoc
<<<<<<< controllers/gdd_controller.go
// @Summary Get GDD Values for given year
// @Tags Gdd, public
// @Security ApiKeyAuth
=======
// @Summary Get gdd values
// @Tags Gdd, public
// @Description get gdd values
>>>>>>> controllers/gdd_controller.go
// @Accept json
// @Produce json
// @Success 200 {object} models.GddResponse
// @Failure 400 {object} errors.StandardError
// @Param year query int true "Year to get gdd for"
// @Param product query string true "Crop to calculate gdd for" Enums(corn, soybean, sunflower, tomato, sugar_beet, peanut, cotton, potato, wheat, pea, oat, spring_wheat, rice, sorghum)
// @Param product query string true "Crop to calculate gdd for" Enums(corn)
// @Param latitude query number true "Latitude to search for"
// @Param longitude query number true "Longitude to search for"
// @Param accumulate query boolean true "Accumulate gdd values"
// @Param plantingDate query string true "Plant date, ISO8601 or RFC3339 format"
// @Param plantingDate query string true "Plant date RFC3339 format"
// @Router /gdd/daily [get]
func GetDailyGdd(c *fiber.Ctx) error {
ctx := common.DawnCtx{FiberCtx: c}
......@@ -33,14 +39,14 @@ func GetDailyGdd(c *fiber.Ctx) error {
}
// GetNormalGdd godoc
// @Summary Get gdd normals
// @Tags Gdd
// @Description get gdd normals
// @Summary Get GDD normals over the past 30 years
// @Tags Gdd, public
// @Security ApiKeyAuth
// @Accept json
// @Produce json
// @Success 200 {object} models.GddResponse
// @Failure 400 {object} errors.StandardError
// @Param product query string true "Crop to calculate gdd for" Enums(corn, soybean, sunflower, tomato, sugar_beet, peanut, cotton, potato, wheat, pea, oat, spring_wheat, rice, sorghum)
// @Param product query string true "Crop to calculate gdd for" Enums(corn)
// @Param latitude query number true "Latitude to search for"
// @Param longitude query number true "Longitude to search for"
// @Param accumulate query boolean true "Accumulate gdd values"
......
......@@ -4,6 +4,12 @@ import (
"gitlab.cs.umd.edu/dawn/go-backend/dawn-gdd/cmd"
)
// @title Dawn GDD Service
// @contact.name API Support
// @contact.email tgsiegel@umd.edu
// @securityDefinitions.apikey ApiKeyAuth
// @in header
// @name Authorization
func main() {
cmd.Execute()
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment