diff options
| author | Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com> | 2023-04-21 12:38:59 +0300 |
|---|---|---|
| committer | Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com> | 2023-04-21 23:57:49 +0300 |
| commit | 568e77f6d9c5d5a34879901f12ee189ade218c7d (patch) | |
| tree | 3681088bd479d8bc5657179f95caf6b7824acc94 /backend | |
| parent | doc: readme (diff) | |
| download | lphub-568e77f6d9c5d5a34879901f12ee189ade218c7d.tar.gz lphub-568e77f6d9c5d5a34879901f12ee189ade218c7d.tar.bz2 lphub-568e77f6d9c5d5a34879901f12ee189ade218c7d.zip | |
doc: added tags
Diffstat (limited to 'backend')
| -rw-r--r-- | backend/controllers/homeController.go | 1 | ||||
| -rw-r--r-- | backend/controllers/loginController.go | 1 | ||||
| -rw-r--r-- | backend/controllers/mapController.go | 1 | ||||
| -rw-r--r-- | backend/controllers/recordController.go | 2 | ||||
| -rw-r--r-- | backend/controllers/userController.go | 4 |
5 files changed, 9 insertions, 0 deletions
diff --git a/backend/controllers/homeController.go b/backend/controllers/homeController.go index b6ab644..539d2c4 100644 --- a/backend/controllers/homeController.go +++ b/backend/controllers/homeController.go | |||
| @@ -22,6 +22,7 @@ func Home(c *gin.Context) { | |||
| 22 | // GET Rankings | 22 | // GET Rankings |
| 23 | // | 23 | // |
| 24 | // @Summary Get rankings of every player. | 24 | // @Summary Get rankings of every player. |
| 25 | // @Tags rankings | ||
| 25 | // @Accept json | 26 | // @Accept json |
| 26 | // @Produce json | 27 | // @Produce json |
| 27 | // @Success 200 {object} models.Response{data=models.RankingsResponse} | 28 | // @Success 200 {object} models.Response{data=models.RankingsResponse} |
diff --git a/backend/controllers/loginController.go b/backend/controllers/loginController.go index 3e59211..6c0453b 100644 --- a/backend/controllers/loginController.go +++ b/backend/controllers/loginController.go | |||
| @@ -18,6 +18,7 @@ import ( | |||
| 18 | // Login | 18 | // Login |
| 19 | // | 19 | // |
| 20 | // @Summary Get (redirect) login page for Steam auth. | 20 | // @Summary Get (redirect) login page for Steam auth. |
| 21 | // @Tags login | ||
| 21 | // @Accept json | 22 | // @Accept json |
| 22 | // @Produce json | 23 | // @Produce json |
| 23 | // @Success 200 {object} models.Response{data=models.LoginResponse} | 24 | // @Success 200 {object} models.Response{data=models.LoginResponse} |
diff --git a/backend/controllers/mapController.go b/backend/controllers/mapController.go index 1560441..16dd669 100644 --- a/backend/controllers/mapController.go +++ b/backend/controllers/mapController.go | |||
| @@ -12,6 +12,7 @@ import ( | |||
| 12 | // GET Map | 12 | // GET Map |
| 13 | // | 13 | // |
| 14 | // @Summary Get map page with specified id. | 14 | // @Summary Get map page with specified id. |
| 15 | // @Tags maps | ||
| 15 | // @Accept json | 16 | // @Accept json |
| 16 | // @Produce json | 17 | // @Produce json |
| 17 | // @Param id path int true "Map ID" | 18 | // @Param id path int true "Map ID" |
diff --git a/backend/controllers/recordController.go b/backend/controllers/recordController.go index 3e64e14..3b4bdc7 100644 --- a/backend/controllers/recordController.go +++ b/backend/controllers/recordController.go | |||
| @@ -21,6 +21,7 @@ import ( | |||
| 21 | // POST Record | 21 | // POST Record |
| 22 | // | 22 | // |
| 23 | // @Summary Post record with demo of a specific map. | 23 | // @Summary Post record with demo of a specific map. |
| 24 | // @Tags maps | ||
| 24 | // @Accept mpfd | 25 | // @Accept mpfd |
| 25 | // @Produce json | 26 | // @Produce json |
| 26 | // @Param Authorization header string true "JWT Token" | 27 | // @Param Authorization header string true "JWT Token" |
| @@ -194,6 +195,7 @@ func CreateRecordWithDemo(c *gin.Context) { | |||
| 194 | // GET Demo | 195 | // GET Demo |
| 195 | // | 196 | // |
| 196 | // @Summary Get demo with specified demo uuid. | 197 | // @Summary Get demo with specified demo uuid. |
| 198 | // @Tags demo | ||
| 197 | // @Accept json | 199 | // @Accept json |
| 198 | // @Produce octet-stream | 200 | // @Produce octet-stream |
| 199 | // @Param uuid path int true "Demo UUID" | 201 | // @Param uuid path int true "Demo UUID" |
diff --git a/backend/controllers/userController.go b/backend/controllers/userController.go index 51c18d5..c86a739 100644 --- a/backend/controllers/userController.go +++ b/backend/controllers/userController.go | |||
| @@ -14,6 +14,7 @@ import ( | |||
| 14 | // GET Profile | 14 | // GET Profile |
| 15 | // | 15 | // |
| 16 | // @Summary Get profile page of session user. | 16 | // @Summary Get profile page of session user. |
| 17 | // @Tags users | ||
| 17 | // @Accept json | 18 | // @Accept json |
| 18 | // @Produce json | 19 | // @Produce json |
| 19 | // @Param Authorization header string true "JWT Token" | 20 | // @Param Authorization header string true "JWT Token" |
| @@ -100,6 +101,7 @@ func Profile(c *gin.Context) { | |||
| 100 | // GET User | 101 | // GET User |
| 101 | // | 102 | // |
| 102 | // @Summary Get profile page of another user. | 103 | // @Summary Get profile page of another user. |
| 104 | // @Tags users | ||
| 103 | // @Accept json | 105 | // @Accept json |
| 104 | // @Produce json | 106 | // @Produce json |
| 105 | // @Param id path int true "User ID" | 107 | // @Param id path int true "User ID" |
| @@ -201,6 +203,7 @@ func FetchUser(c *gin.Context) { | |||
| 201 | // PUT Profile | 203 | // PUT Profile |
| 202 | // | 204 | // |
| 203 | // @Summary Update profile page of session user. | 205 | // @Summary Update profile page of session user. |
| 206 | // @Tags users | ||
| 204 | // @Accept json | 207 | // @Accept json |
| 205 | // @Produce json | 208 | // @Produce json |
| 206 | // @Param Authorization header string true "JWT Token" | 209 | // @Param Authorization header string true "JWT Token" |
| @@ -243,6 +246,7 @@ func UpdateUser(c *gin.Context) { | |||
| 243 | // PUT Profile/CountryCode | 246 | // PUT Profile/CountryCode |
| 244 | // | 247 | // |
| 245 | // @Summary Update country code of session user. | 248 | // @Summary Update country code of session user. |
| 249 | // @Tags users | ||
| 246 | // @Accept json | 250 | // @Accept json |
| 247 | // @Produce json | 251 | // @Produce json |
| 248 | // @Param Authorization header string true "JWT Token" | 252 | // @Param Authorization header string true "JWT Token" |