fix typos in endpoint documentation

This commit is contained in:
Sonja Happ 2019-09-06 15:08:49 +02:00
parent dab027eef6
commit 30c13c64de

View file

@ -112,7 +112,7 @@ func addDashboard(c *gin.Context) {
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param inputDab body dashboard.validUpdatedDashboard true "Dashboard to be updated" // @Param inputDab body dashboard.validUpdatedDashboard true "Dashboard to be updated"
// @Success 200 {object} docs.ResponseDashboard "Dashboards that was updated" // @Success 200 {object} docs.ResponseDashboard "Dashboard that was updated"
// @Failure 400 {object} docs.ResponseError "Bad request" // @Failure 400 {object} docs.ResponseError "Bad request"
// @Failure 404 {object} docs.ResponseError "Not found" // @Failure 404 {object} docs.ResponseError "Not found"
// @Failure 422 {object} docs.ResponseError "Unprocessable entity" // @Failure 422 {object} docs.ResponseError "Unprocessable entity"
@ -143,7 +143,7 @@ func updateDashboard(c *gin.Context) {
}) })
return return
} }
// Create the updatedScenario from oldScenario // Create the updatedDashboard from oldDashboard
updatedDashboard, err := req.updatedDashboard(oldDashboard) updatedDashboard, err := req.updatedDashboard(oldDashboard)
if err != nil { if err != nil {
c.JSON(http.StatusBadRequest, gin.H{ c.JSON(http.StatusBadRequest, gin.H{
@ -171,7 +171,7 @@ func updateDashboard(c *gin.Context) {
// @ID getDashboard // @ID getDashboard
// @Tags dashboards // @Tags dashboards
// @Produce json // @Produce json
// @Success 200 {object} docs.ResponseDashboard "Dashboards that was requested" // @Success 200 {object} docs.ResponseDashboard "Dashboard that was requested"
// @Failure 400 {object} docs.ResponseError "Bad request" // @Failure 400 {object} docs.ResponseError "Bad request"
// @Failure 404 {object} docs.ResponseError "Not found" // @Failure 404 {object} docs.ResponseError "Not found"
// @Failure 422 {object} docs.ResponseError "Unprocessable entity" // @Failure 422 {object} docs.ResponseError "Unprocessable entity"
@ -195,7 +195,7 @@ func getDashboard(c *gin.Context) {
// @ID deleteDashboard // @ID deleteDashboard
// @Tags dashboards // @Tags dashboards
// @Produce json // @Produce json
// @Success 200 {object} docs.ResponseDashboard "Dashboards that was deleted" // @Success 200 {object} docs.ResponseDashboard "Dashboard that was deleted"
// @Failure 400 {object} docs.ResponseError "Bad request" // @Failure 400 {object} docs.ResponseError "Bad request"
// @Failure 404 {object} docs.ResponseError "Not found" // @Failure 404 {object} docs.ResponseError "Not found"
// @Failure 422 {object} docs.ResponseError "Unprocessable entity" // @Failure 422 {object} docs.ResponseError "Unprocessable entity"