添加审核规范

demo/index.apib

@@ -14,7 +14,7 @@ see [The Rules of Go](https://en.wikipedia.org/wiki/Rules_of_go)
 
 用户模块
 
-### user page [GET /admin/user/page{?current,size,other}]
+### user page [GET /upms/user/page{?current,size,other}]
 
 用户分页
 
@@ -25,22 +25,35 @@ see [The Rules of Go](https://en.wikipedia.org/wiki/Rules_of_go)
     + size (number, optional) - 每页几条
         + Default: `20`
     + other (number, optional) - 这里是搜索参数, 如 `username` 用户名搜索.
-        + Default: `张超`
+        + Default: `<UserName>`
 
 + Response 200 (application/json)
 
-        {"code":0,"msg":"success","data":{"records":[{"userId":1,"username":"admin","password":"$2a$10$QOfWxxFyAMmEEmnuw9UI/..1s4B4eF/u9PzE2ZaGO.ij9YfmcUy.u","salt":null,"wxOpenid":"o_0FT0uyg_H1vVy2H0JpSwlVGhWQ","qqOpenid":null,"createTime":"2018-04-20 07:15:18","updateTime":"2019-01-05 17:11:20","delFlag":"0","lockFlag":"0","phone":"17034642888","avatar":"lengleng-oxjkuoy361p6x5snlogo.png","deptId":1,"tenantId":1,"deptName":null,"roleList":[{"roleId":1,"roleName":"管理员","roleCode":"ROLE_ADMIN","roleDesc":"管理员","dsType":2,"dsScope":"2","createTime":"2017-10-29 15:45:51","updateTime":"2018-12-26 14:09:11","delFlag":"0"}]}],"total":1,"size":20,"current":1,"searchCount":true,"pages":1}}
+        {"code":0,"msg":"success","data":{"records":[{"id":1,"username":"admin","createTime":"2018-04-20 07:15:18","updateTime":"2019-01-05 17:11:20","phone":"17034642888","roleList":[{"id":1,"name":"管理员","code":"ROLE_ADMIN","desc":"管理员","type":2,"scope":"2","createTime":"2017-10-29 15:45:51","updateTime":"2018-12-26 14:09:11"}]}],"total":1,"size":20,"current":1,"searchCount":true,"pages":1}}
 
-### create user  [POST /admin/user/create]
+### user detail [GET /upms/user/{id}]
 
-用户新增.
+用户详情
+
+
++ Parameters
+
+    + id: `90` (int) - 用户ID
+
++ Response 200 (application/json)
+
+        {"code":0,"msg":"success", "data":{"id":1,"username":"admin","createTime":"2018-04-20 07:15:18","updateTime":"2019-01-05 17:11:20","phone":"17034642888","roleList":[{"id":1,"name":"管理员","code":"ROLE_ADMIN","desc":"管理员","type":2,"scope":"2","createTime":"2017-10-29 15:45:51","updateTime":"2018-12-26 14:09:11"}]}}
+
+### create user  [POST /upms/user/create]
+
+用户新增
 
 + Request (application/json)
 
         {
             "username" : "zhangchao",
-            "playerWhite" : "bob",
-            "playerBlack" : "alfred"
+            "phone" : "17034642888",
+            "roleIds" : [1, 2, 3],
         }
 
 
@@ -48,7 +61,7 @@ see [The Rules of Go](https://en.wikipedia.org/wiki/Rules_of_go)
 
         {"code":0,"msg":"success","data":true}
 
-### delete user [POST /admin/user/delete/{id}]
+### delete user [POST /upms/user/delete/{id}]
 
 用户删除
 
@@ -61,7 +74,7 @@ see [The Rules of Go](https://en.wikipedia.org/wiki/Rules_of_go)
 
         {"code":0,"msg":"success","data":true}
 
-### update user [POST /admin/user/update]
+### update user [POST /upms/user/update]
 
 用户更新
 
@@ -70,8 +83,55 @@ see [The Rules of Go](https://en.wikipedia.org/wiki/Rules_of_go)
         {
             "id": 1,
             "username" : "zhangchao",
-            "playerWhite" : "bob",
-            "playerBlack" : "alfred"
+            "phone" : "17034642888",
+            "roleIds" : [1, 2, 3],
+        }
+
++ Response 200 (application/json)
+
+        {"code":0,"msg":"success","data":true}
+
+
+# Group goms
+
+组织模块
+
+## goms upms
+
+用户组织模块
+
+### user apply [POST /goms/{uid}/apply/{oid}]
+
+用户申请加入组织，加入组织理由可选放在`request body`里
+
++ Parameters
+
+    + uid: `90` (int) - 申请的用户的ID
+    + oid: `90` (int) - 被申请的组织的ID
+
++ Request (application/json)
+
+        {
+            "desc" : "我申请加入的理由"
+        }
+
++ Response 200 (application/json)
+
+        {"code":0,"msg":"success","data":true}
+
+### user apply [POST /goms/review/{uid}]
+
+组织通过与驳回请求，驳回的理由放在`request body`里
+
++ Parameters
+
+    + uid: `90` (int) - 申请的用户的ID
+
++ Request (application/json)
+
+        {
+            "isPass": true // true 通过， false 驳回
+            "desc" : "驳回的理由"
         }
 
 + Response 200 (application/json)