From 596a7219cf9573a108d1ad2d93ea84f14019e9df Mon Sep 17 00:00:00 2001 From: Paul Pan Date: Mon, 18 Dec 2023 21:21:15 +0800 Subject: [PATCH] chore: add tag on router --- internal/api/problem/createVersion.go | 1 + internal/api/problem/details.go | 1 + internal/api/problem/search.go | 1 + internal/api/problem/update.go | 1 + internal/api/problem/upload.go | 1 + internal/api/status/query.go | 1 + internal/api/status/queryByVersion.go | 1 + internal/api/submission/create.go | 1 + internal/api/submission/query.go | 1 + internal/api/submission/rejudge.go | 1 + internal/api/user/create.go | 1 + internal/api/user/login.go | 1 + internal/api/user/logout.go | 1 + internal/api/user/profile.go | 1 + 14 files changed, 14 insertions(+) diff --git a/internal/api/problem/createVersion.go b/internal/api/problem/createVersion.go index c315414..4302f17 100644 --- a/internal/api/problem/createVersion.go +++ b/internal/api/problem/createVersion.go @@ -15,6 +15,7 @@ type createVersionRequest struct { // CreateVersion // @Summary create a problem version // @Description create a problem version +// @Tags problem // @Accept application/x-www-form-urlencoded // @Produce json // @Param pid formData int true "problem id" diff --git a/internal/api/problem/details.go b/internal/api/problem/details.go index c2055bf..201d2ff 100644 --- a/internal/api/problem/details.go +++ b/internal/api/problem/details.go @@ -13,6 +13,7 @@ type detailsRequest struct { // Details // @Summary get details of a problem // @Description get details of a problem +// @Tags problem // @Accept application/x-www-form-urlencoded // @Produce json // @Param pid formData int true "problem id" diff --git a/internal/api/problem/search.go b/internal/api/problem/search.go index 7c7a70c..d473de3 100644 --- a/internal/api/problem/search.go +++ b/internal/api/problem/search.go @@ -12,6 +12,7 @@ type searchRequest struct { // Search // @Summary get detail of a problem // @Description get detail of a problem +// @Tags problem // @Accept application/x-www-form-urlencoded // @Produce json // @Param search formData string false "word search" diff --git a/internal/api/problem/update.go b/internal/api/problem/update.go index 82b3e65..4fd36c8 100644 --- a/internal/api/problem/update.go +++ b/internal/api/problem/update.go @@ -17,6 +17,7 @@ type updateRequest struct { // Update // @Summary create or update a problem // @Description create or update a problem +// @Tags problem // @Accept application/x-www-form-urlencoded // @Produce json // @Param pid formData int false "problem id, 0 for create" diff --git a/internal/api/problem/upload.go b/internal/api/problem/upload.go index c0483be..746ba02 100644 --- a/internal/api/problem/upload.go +++ b/internal/api/problem/upload.go @@ -11,6 +11,7 @@ import ( // Upload // @Summary get upload url // @Description get upload url +// @Tags problem // @Produce json // @Response 200 {object} e.Response "upload url and key" // @Security Authentication diff --git a/internal/api/status/query.go b/internal/api/status/query.go index faf98c8..ebea0d1 100644 --- a/internal/api/status/query.go +++ b/internal/api/status/query.go @@ -12,6 +12,7 @@ type queryRequest struct { // Query // @Summary query submissions by via submission id // @Description query submissions by via submission id +// @Tags status // @Accept application/x-www-form-urlencoded // @Produce json // @Param sid formData uint true "submission id" diff --git a/internal/api/status/queryByVersion.go b/internal/api/status/queryByVersion.go index 04bc72d..c6a4b3b 100644 --- a/internal/api/status/queryByVersion.go +++ b/internal/api/status/queryByVersion.go @@ -15,6 +15,7 @@ type queryByVersionRequest struct { // QueryByProblemVersion // @Summary query submissions by problem version (admin only) // @Description query submissions by problem version (admin only) +// @Tags status // @Accept application/x-www-form-urlencoded // @Produce json // @Param pvid formData uint true "problem version id" diff --git a/internal/api/submission/create.go b/internal/api/submission/create.go index 3b4a677..c55e50b 100644 --- a/internal/api/submission/create.go +++ b/internal/api/submission/create.go @@ -16,6 +16,7 @@ type createRequest struct { // Create // @Summary create a submission // @Description create a submission +// @Tags submission // @Accept application/x-www-form-urlencoded // @Produce json // @Param pid formData int true "problem id" diff --git a/internal/api/submission/query.go b/internal/api/submission/query.go index a63683a..a44d569 100644 --- a/internal/api/submission/query.go +++ b/internal/api/submission/query.go @@ -21,6 +21,7 @@ type queryResponse struct { // Query // @Summary Query submissions // @Description Query submissions +// @Tags submission // @Accept application/x-www-form-urlencoded // @Produce json // @Param pid formData uint false "problem id" diff --git a/internal/api/submission/rejudge.go b/internal/api/submission/rejudge.go index 47cfc6a..ef43dd9 100644 --- a/internal/api/submission/rejudge.go +++ b/internal/api/submission/rejudge.go @@ -13,6 +13,7 @@ type rejudgeRequest struct { // Rejudge // @Summary rejudge a submission // @Description rejudge a submission +// @Tags submission // @Accept application/x-www-form-urlencoded // @Produce json // @Param sid formData int true "submission id" diff --git a/internal/api/user/create.go b/internal/api/user/create.go index 1e61a29..7ec9599 100644 --- a/internal/api/user/create.go +++ b/internal/api/user/create.go @@ -16,6 +16,7 @@ type createRequest struct { // Create // @Summary create a new user // @Description create a new user +// @Tags user // @Accept application/x-www-form-urlencoded // @Produce json // @Param username formData string true "username" diff --git a/internal/api/user/login.go b/internal/api/user/login.go index 9525783..c6a67ff 100644 --- a/internal/api/user/login.go +++ b/internal/api/user/login.go @@ -15,6 +15,7 @@ type loginRequest struct { // Login // @Summary login // @Description login and return token +// @Tags user // @Accept application/x-www-form-urlencoded // @Produce json // @Param username formData string true "username" diff --git a/internal/api/user/logout.go b/internal/api/user/logout.go index 7e6d00e..f1b2a34 100644 --- a/internal/api/user/logout.go +++ b/internal/api/user/logout.go @@ -9,6 +9,7 @@ import ( // Logout // @Summary logout // @Description logout +// @Tags user // @Accept application/x-www-form-urlencoded // @Produce json // @Response 200 {object} e.Response "nil" diff --git a/internal/api/user/profile.go b/internal/api/user/profile.go index 3abe353..68c85fa 100644 --- a/internal/api/user/profile.go +++ b/internal/api/user/profile.go @@ -13,6 +13,7 @@ type profileRequest struct { // Profile // @Summary profile // @Description fetch user profile +// @Tags user // @Accept application/x-www-form-urlencoded // @Produce json // @Param uid formData int false "user id"