Skip to content

A Q&A platform software for teams at any scales. Whether it's a community forum, help center, or knowledge management platform, you can always count on Apache Answer.

refactor(api): rename methods and update documentation for clarity

LinkinStarsd82c75d7ccdd
diff --git a/internal/controller/answer_controller.go b/internal/controller/answer_controller.go
index a22c597f..7c5aca1d 100644
--- a/internal/controller/answer_controller.go
+++ b/internal/controller/answer_controller.go
@@ -292,7 +292,7 @@ func (ac *AnswerController) AddAnswer(ctx *gin.Context) {
})
}
-// Update godoc
+// UpdateAnswer update answer
// @Summary Update Answer
// @Description Update Answer
// @Tags Answer
@@ -300,9 +300,9 @@ func (ac *AnswerController) AddAnswer(ctx *gin.Context) {
// @Produce json
// @Security ApiKeyAuth
// @Param data body schema.AnswerUpdateReq true "AnswerUpdateReq"
-// @Success 200 {string} string ""
+// @Success 200 {object} handler.RespBody{}
// @Router /answer/api/v1/answer [put]
-func (ac *AnswerController) Update(ctx *gin.Context) {
+func (ac *AnswerController) UpdateAnswer(ctx *gin.Context) {
req := &schema.AnswerUpdateReq{}
if handler.BindAndCheck(ctx, req) {
return
@@ -402,17 +402,17 @@ func (ac *AnswerController) AnswerList(ctx *gin.Context) {
})
}
-// Accepted godoc
-// @Summary Accepted
-// @Description Accepted
+// AcceptAnswer accept answer
+// @Summary Accept Answer
+// @Description Accept Answer
// @Tags Answer
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Param data body schema.AcceptAnswerReq true "AcceptAnswerReq"
-// @Success 200 {string} string ""
+// @Success 200 {object} handler.RespBody{}
// @Router /answer/api/v1/answer/acceptance [post]
-func (ac *AnswerController) Accepted(ctx *gin.Context) {
+func (ac *AnswerController) AcceptAnswer(ctx *gin.Context) {
req := &schema.AcceptAnswerReq{}
if handler.BindAndCheck(ctx, req) {
return
diff --git a/internal/router/answer_api_router.go b/internal/router/answer_api_router.go
index cba23707..1191492b 100644
--- a/internal/router/answer_api_router.go
+++ b/internal/router/answer_api_router.go
@@ -266,8 +266,8 @@ func (a *AnswerAPIRouter) RegisterAnswerAPIRouter(r *gin.RouterGroup) {
// answer
r.POST("/answer", a.answerController.AddAnswer)
- r.PUT("/answer", a.answerController.Update)
- r.POST("/answer/acceptance", a.answerController.Accepted)
+ r.PUT("/answer", a.answerController.UpdateAnswer)
+ r.POST("/answer/acceptance", a.answerController.AcceptAnswer)
r.DELETE("/answer", a.answerController.RemoveAnswer)
r.POST("/answer/recover", a.answerController.RecoverAnswer)