From 60fcf785ced334998e8dd19aea3b71be6a2db14f Mon Sep 17 00:00:00 2001
From: Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com>
Date: Sat, 2 Sep 2023 13:52:45 +0300
Subject: docs: update docs for logs (#55)

Former-commit-id: 0478aa459bfe9a7c81073d4ff8d8264aa1258bc1
---
 backend/handlers/logs.go | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'backend/handlers/logs.go')

diff --git a/backend/handlers/logs.go b/backend/handlers/logs.go
index 0ebba47..5233738 100644
--- a/backend/handlers/logs.go
+++ b/backend/handlers/logs.go
@@ -49,6 +49,15 @@ type ScoreLogsResponseDetails struct {
 	Date       time.Time        `json:"date"`
 }
 
+// GET Mod Logs
+//
+//	@Description	Get mod logs.
+//	@Tags			rankings
+//	@Produce		json
+//	@Param			Authorization	header		string	true	"JWT Token"
+//	@Success		200				{object}	models.Response{data=ScoreLogsResponse}
+//	@Failure		400				{object}	models.Response
+//	@Router			/logs/mod [get]
 func ModLogs(c *gin.Context) {
 	mod, exists := c.Get("mod")
 	if !exists || !mod.(bool) {
@@ -86,6 +95,14 @@ func ModLogs(c *gin.Context) {
 	})
 }
 
+// GET Score Logs
+//
+//	@Description	Get score logs of every player.
+//	@Tags			rankings
+//	@Produce		json
+//	@Success		200	{object}	models.Response{data=ScoreLogsResponse}
+//	@Failure		400	{object}	models.Response
+//	@Router			/logs/score [get]
 func ScoreLogs(c *gin.Context) {
 	response := ScoreLogsResponse{Logs: []ScoreLogsResponseDetails{}}
 	sql := `SELECT g.id,
-- 
cgit v1.2.3