Skip to content

Commit ef1cdb7

Browse files
add swagger docs for club rating
1 parent 702ff60 commit ef1cdb7

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

internal/handlers/club.go

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -460,6 +460,18 @@ func (h *ClubHandler) GetClubMember(c *gin.Context) {
460460
c.JSON(http.StatusOK, gin.H{"member": member})
461461
}
462462

463+
// @Summary Rate a club
464+
// @Description Rate a club by its ID
465+
// @Tags Clubs
466+
// @Accept json
467+
// @Produce json
468+
// @Param id path int true "Club ID"
469+
// @Param request body models.RateClubRequest true "Club rating data"
470+
// @Success 200 {object} map[string]interface{} "Club rated successfully"
471+
// @Failure 400 {object} map[string]string "Bad request"
472+
// @Failure 401 {object} map[string]string "Unauthorized"
473+
// @Failure 500 {object} map[string]string "Internal server error"
474+
// @Router /api/v1/clubs/{id}/rate [post]
463475
func (h *ClubHandler) RateClub(c *gin.Context) {
464476
clubIDParam := c.Param("id")
465477
clubID64, err := strconv.ParseUint(clubIDParam, 10, 32)
@@ -503,6 +515,17 @@ func (h *ClubHandler) RateClub(c *gin.Context) {
503515
})
504516
}
505517

518+
// @Summary List club ratings
519+
// @Description List all ratings for a club by its ID
520+
// @Tags Clubs
521+
// @Produce json
522+
// @Param id path int true "Club ID"
523+
// @Param limit query int false "Limit" default(20)
524+
// @Param offset query int false "Offset" default(0)
525+
// @Success 200 {object} map[string]interface{} "List of club ratings"
526+
// @Failure 400 {object} map[string]string "Bad request"
527+
// @Failure 500 {object} map[string]string "Internal server error"
528+
// @Router /api/v1/clubs/{id}/ratings [get]
506529
func (h *ClubHandler) ListClubRatings(c *gin.Context) {
507530
clubIDParam := c.Param("id")
508531
clubID64, err := strconv.ParseUint(clubIDParam, 10, 32)

0 commit comments

Comments
 (0)