[GitHub] [apisix-dashboard] tokers commented on a change in pull request #992: feat: use Swagger to maintain API document for Manager API

[GitBox <gi...@apache.org>]

tokers commented on a change in pull request #992:
URL: https://github.com/apache/apisix-dashboard/pull/992#discussion_r539104527



##########
File path: api/internal/handler/authentication/authentication.go
##########
@@ -47,11 +47,43 @@ type UserSession struct {
 	Token string `json:"token"`
 }
 
+// swagger:model LoginInput
 type LoginInput struct {
+	// user name
 	Username string `json:"username" validate:"required"`
+	// password
 	Password string `json:"password" validate:"required"`
 }
 
+// swagger:operation POST /apisix/admin/user/login userLogin
+//
+// user login
+//
+// user login

Review comment:
       duplicated?

##########
File path: api/internal/handler/service/service.go
##########
@@ -89,6 +89,42 @@ type ListInput struct {
 	store.Pagination
 }
 
+// swagger:operation GET /apisix/admin/services getServiceList
+//
+// Returns service list
+//
+// Return the service list according to the specified page number and page size, and can search by name

Review comment:
       English Style: keep the singular consistent.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org