Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix:#34 Add swagger comments in problem.go #58

Merged
merged 2 commits into from
Mar 22, 2024
Merged

Fix:#34 Add swagger comments in problem.go #58

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e759695
Fix:#34 Add swagger comments in /src/server/handler/problem.go and ge…
sirius2alpha Mar 22, 2024
f2ffae2
Fix:#34 Add swagger comments in problem.go
sirius2alpha Mar 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions src/application/server/handler/problem.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ func SetupProblemRoute(baseRoute *gin.RouterGroup) {
}
}

// getProblem
//
// @Router /problem/{slug} [get]
// @Summary Get a problem
// @Description Get a problem
// @Tags problem
// @Accept json
// @Success 200
func getProblem(ginCtx *gin.Context) {
slug := ginCtx.Param("slug")

Expand All @@ -42,6 +50,13 @@ func getProblem(ginCtx *gin.Context) {
})
}

// putProblem
//
// @Router /problem [put]
// @Summary Put a problem
// @Description Put a problem
// @Tags problem
// @Accept json
func putProblem(ginCtx *gin.Context) {
problem := model.Problem{}
if err := ginCtx.ShouldBindJSON(&problem); err != nil {
Expand All @@ -56,6 +71,13 @@ func putProblem(ginCtx *gin.Context) {
}
}

// deleteProblem
//
// @Router /problem/{slug} [delete]
// @Summary Delete a problem
// @Description Delete a problem
// @Tags problem
// @Accept json
func deleteProblem(ginCtx *gin.Context) {
slug := ginCtx.Param("slug")

Expand Down Expand Up @@ -87,6 +109,14 @@ func getProblemInfoList(ginCtx *gin.Context) {
})
}

// putProblemPackage
//
// @Router /problem/{slug}/package [put]
// @Summary Put problem package
// @Description Put problem package
// @Tags problem
// @Accept json
// @Param slug path string true "problem slug"
func putProblemPackage(ginCtx *gin.Context) {
slug := ginCtx.Param("slug")
file, err := ginCtx.FormFile("file")
Expand All @@ -105,6 +135,15 @@ func putProblemPackage(ginCtx *gin.Context) {
ginCtx.Done()
}

// checkProblemSlug
//
// @Router /problem/{slug}/check [get]
// @Summary Check problem slug
// @Description Check problem slug
// @Tags problem
// @Accept json
// @Success 200
// @Param slug path string true "problem slug"
func checkProblemSlug(ginCtx *gin.Context) {
slug := ginCtx.Param("slug")

Expand All @@ -119,6 +158,11 @@ func checkProblemSlug(ginCtx *gin.Context) {
})
}

// PostSubmissionBody
//
// @Description The body of a submission request, containing the code and the language used for the submission.
// @Property code (string) required "The source code of the submission" minlength(1)
// @Property language (SubmissionLanguage) required "The programming language used for the submission"
type PostSubmissionBody struct {
Code string `json:"code" binding:"required"`
Language model.SubmissionLanguage `json:"language" binding:"required"`
Expand Down
Loading