feat(users): update api docs

LinkinStars · LinkinStars · commit 1cd4e2740d0f · 2023-08-14T16:42:41.000+08:00
diff --git a/docs/docs.go b/docs/docs.go
diff --git a/docs/swagger.json b/docs/swagger.json
@@ -1754,7 +1754,7 @@
                         "in": "body",
                         "required": true,
                         "schema": {
-                            "$ref": "#/definitions/schema.AddUserReq"
+                            "$ref": "#/definitions/schema.AddUsersReq"
                         }
                     }
                 ],
@@ -6514,6 +6514,15 @@
                 }
             }
         },
+        "schema.AddUsersReq": {
+            "type": "object",
+            "properties": {
+                "users": {
+                    "description": "users info line by line",
+                    "type": "string"
+                }
+            }
+        },
         "schema.AdminSetAnswerStatusRequest": {
             "type": "object",
             "properties": {
diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -230,6 +230,12 @@ definitions:
     - email
     - password
     type: object
+  schema.AddUsersReq:
+    properties:
+      users:
+        description: users info line by line
+        type: string
+    type: object
   schema.AdminSetAnswerStatusRequest:
     properties:
       answer_id:
@@ -3392,7 +3398,7 @@ paths:
         name: data
         required: true
         schema:
-          $ref: '#/definitions/schema.AddUserReq'
+          $ref: '#/definitions/schema.AddUsersReq'
       produces:
       - application/json
       responses:
diff --git a/internal/controller_admin/user_backyard_controller.go b/internal/controller_admin/user_backyard_controller.go
@@ -98,7 +98,7 @@ func (uc *UserAdminController) AddUser(ctx *gin.Context) {
 // @Tags admin
 // @Accept json
 // @Produce json
-// @Param data body schema.AddUserReq true "user"
+// @Param data body schema.AddUsersReq true "user"
 // @Success 200 {object} handler.RespBody
 // @Router /answer/admin/api/users [post]
 func (uc *UserAdminController) AddUsers(ctx *gin.Context) {

Original file line number	Diff line number	Diff line change
`@@ -1754,7 +1754,7 @@`
`1754`	`1754`	`"in": "body",`
`1755`	`1755`	`"required": true,`
`1756`	`1756`	`"schema": {`
`1757`		`- "$ref": "#/definitions/schema.AddUserReq"`
	`1757`	`+ "$ref": "#/definitions/schema.AddUsersReq"`
`1758`	`1758`	`}`
`1759`	`1759`	`}`
`1760`	`1760`	`],`
`@@ -6514,6 +6514,15 @@`
`6514`	`6514`	`}`
`6515`	`6515`	`}`
`6516`	`6516`	`},`
	`6517`	`+ "schema.AddUsersReq": {`
	`6518`	`+ "type": "object",`
	`6519`	`+ "properties": {`
	`6520`	`+ "users": {`
	`6521`	`+ "description": "users info line by line",`
	`6522`	`+ "type": "string"`
	`6523`	`+ }`
	`6524`	`+ }`
	`6525`	`+ },`
`6517`	`6526`	`"schema.AdminSetAnswerStatusRequest": {`
`6518`	`6527`	`"type": "object",`
`6519`	`6528`	`"properties": {`