apidoc.yaml

  swagger: '2.0'
  
  ### information start ###
  info:
    description: work.muxixyz.com API 
    version: 1.0.0
    title: Work API
    contact:
      email: shiina_orez@qq.com
    #license
  ### information end ###
  
  host: work.muxixyz.com
  basePath: /api/v1.0
  schemes:
    - https
    - http
  
  ### tag start ###
  
  tags:
    - name: auth
      description: 身份验证服务
  
    - name: management
      description: 成员管理服务
  
    - name: feed
      description: feed流服务
  
    - name: message
      description: 消息服务
  
    - name: status
      description: 进度服务

    - name: search
      description: 搜索服务 
    - name: project
      description: 项目服务 
    - name: file
      description: 文件服务

  ### tag end ###
  
  ### auth start ###
  
  securityDefinitions:
  
    basic:
      type: basic
      description: http basic auth,即在请求头中添加Authorization字段，内容为base64.encode(“邮箱:muxi304”)
  
    token:
      type: apiKey
      description: token,然后在请求头中添加Authorization字段，内容为base64.encode(“token:”)
      name: token
      in: header
  
  ### auth end ###
  
  ### path start ###
  
  paths:
    /auth/signup/:
      post:
        tags:
          - auth
        summary: Signup a account.
        description: Just save a list of user.
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - name: POSTdata
            in: body
            description: data to fill the segments
            schema:
              required:
                - name
                - email
                - avatar
                - tel
              properties:
                name:
                  type: string
                email:
                  type: string
                avatar:
                  type: string
                tel:
                  type: string
                teamID:
                  type: integer
        responses:
          200:
            description: Signup successfully
          401:
            description: User already exist
    /auth/login/:
      post:
        tags:
          - auth
        summary: Login a account
        description: Get a token formed by user-info
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - name: POSTdata
            in: body
            description: data to mark who want a token
            schema:
              required:
                - email
              properties:
                email:
                  type: string
        responses:
          200:
            description: Return a token
            schema:
              required:
                - token
                - uid
                - urole
              properties:
                token:
                  type: string
                uid:
                  type: integer
                urole:
                  type: integer 
    
    
     
    /user/2bSuperuser/:
      post:
        tags:
          - management
        summary: create a superuser
        description: get username and add it to superuser
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - name: name
            in: body
            description: username
            required: true
            schema:
              type: string
        responses:
          200:
            description: ok
    /group/new/:
      post:
        tags:
          - management
        summary: post a new group
        description: a groupName and a user list
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - name: POSTdata
            in: body
            description: data to set a enw group
            schema:
              required:
                - groupName
                - userList
              properties:
                groupName:
                  type: string
                userlist:
                  type: array
                  items:
                    required:
                      - userID
                    properties:
                      userID:
                        type: integer
        responses:
          200:
            description: successful!
          402:
            description: user list is None!/ group name exist！
        security:
        - token: []
    /group/{gid}/:
      delete:
        tags:
          - management
        summary: delete a group
        description: DANGER:must be superuser can delete a group
        produces:
          - application/json
        parameters:
          - in: path
            name: gid
            description: groupID
            required: true
            type: integer
        responses:
          200:
            description: ok
        security:
        - token: []  
    /group/<gid>/rename/:
      post:
        tags:
          - management
        summary: rename the group
        description: get a new group name
        produces:
          - application/json
        parameters:
          - in: path
            name: gid
            description: groupID
            required: true
            type: integer
          - name: rename
            in: body
            description: a new group name
            required: true
            schema:
              type: string
        responses:
          200:
            description: rename successful!
          402:
            description: rename is None/please keep group name unique
    /group/{gid}/userList/:
      get:
        tags:
          - management
        summary: group user list
        description: get a user list by group id/ if gid ==0 ,get all users 
        produces:
          - application/json
        parameters:
          - in: path
            name: gid
            description: groupID
            required: true
            type: integer
        responses:
          200:
            description: user list
            schema:
              required: 
                - count
                - list
              properties:
                count:
                  type: integer
                list:
                  type: array
                  items:
                    required:
                      - teamID
                      - username
                      - userID
                      - groupName
                      - groupID
                      - role
                      - email
                      - avatar
                    properties:
                      teamID:
                        type: integer
                      username:
                        type: string
                      userID:
                        type: integer
                      groupName:
                        type: string
                      groupID:
                        type: integer
                      role:
                        type: integer
                      email:
                        type: string
                      avatar:
                        type: string
        security:
        - token: []
    /group/list/:
      get:
        tags:
          - management
        summary: get a group list
        description: verify token and get a list/all group list
        produces:
          - application/json
        responses:
          200:
            description: OK
            schema:
              required:
                - groupList
              properties:
                groupList:
                  type: array
                  items:
                    required:
                      - groupID
                      - groupName
                      - userCount
                    properties:
                      groupID:
                        type: integer
                      groupName:
                        type: string
                      userCount:
                        type: integer
        security:
        - token: []  
  
    /group/{gid}/manageUser/:
      post:
        tags:
          - management
        summary: change group members by list
        description: get a list of userID and change it
        produces:
          - application/json
        consumes:
          - application/json
        parameters:
          - in: path
            name: gid
            description: groupID
            required: true
            type: integer
          - in: body
            name: POSTdata
            description: userID List
            schema:
              required:
                - userList
              properties:
                userList:
                  type: array
                  items:
                    required:
                      - userID
                    properties:
                      userID:
                        type: integer
        responses:
          200:
            description: OK
        security:
        - token: []  
    /project/{pid}/userList/:
      get:
        tags:
          - management
        summary: get project user list
        description: get a list of user by projectID
        produces:
          - application/json
        parameters:
          - in: path
            name: pid
            description: projectID
            required: true
            type: integer
        responses:
          200:
            description: user list
            schema:
              required:
                - list
                - count
              properties:
                count:
                  type: integer
                list:
                  type: array
                  items:
                    required:
                      - username
                      - userID
                      - avatar
                    properties:
                      username:
                        type: string
                      userID:
                        type: integer
                      avatar:
                        type: string 
        security:
        - token: []
    /user/{uid}/project/list/:
      get:
        tags:
          - management
        summary: get a project list
        description: verify token and get a list/ if you are admin or superuser, get all projetc list
        produces:
          - application/json
        parameters:
          - in: path
            name: uid
            description: user ID
            required: true
            type: integer
        responses:
          200:
            description: OK
            schema:
              required:
                - list
                - count
                - pageMax
                - pageNow
                - hasNext
              properties:
                pagewMax:
                  type: integer
                pageNow:
                  type: integer
                hasNext:
                  type: boolean
                count:
                  type: integer
                list:
                  type: array
                  items:
                    required:
                      - projectID
                      - projectName
                      - userCount
                      - intro
                    properties:
                      projectID:
                        type: integer
                      projectName:
                        type: string
                      userCount:
                        type: integer
                      intro:
                        type: string
        security:
        - token: []
    /user/{uid}/:
      delete:
        tags:
          - management
        summary: remove user out of team
        description: set role=0 and remove all data to None
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - in: path
            name: uid
            description: user ID
            required: true
            type: integer
        responses:
          200:
            description: OK
          402:
            description: Never give up yourself!
        security:
          - token: []
  
    /user/2bMember/:
      post:
        tags:
          - management
        summary: accept a new member
        description: receive a user ID
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - name: POSTdata
            in: body
            description: userID
            schema:
              required:
                - userID
              properties:
                userID:
                  type: integer
        responses:
          200:
            description: successful!
          402:
            description: user already be a member
        security:
        - token: []
    /user/admins/:
      get:
        tags:
          - management
        summary: get a list of admin
        description: verify token and get a list of admin
        consumes:
          - application/json
        produces:
          - application/json
        responses:
          200:
            description: OK
            schema:
              required:
                - list
              properties:
                list:
                  type: array
                  items:
                    required:
                      - userID
                      - userName
                    properties:
                      userID:
                        type: integer
                      userName:
                        type: string
          201:
            description: No one is admin
    /user/addAdmin/:
      post:
        tags:
          - management
        summary: super user add someone on admin list
        description: verify token and add a FK
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - name: POSTdata
            in: body
            description: who are the lucky dog
            schema:
              required:
                - luckydog
              properties:
                luckydog:
                  type: integer
        responses:
          200:
            description: luckydog be a admin
        security:
        - token: []
    /user/delAdmin/:
      post:
        tags:
          - management
        summary: super user delete someone on admin list
        description: verify token and delete a FK
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - name: POSTdata
            in: body
            description: who is the unlucky dog
            schema:
              required:
                - unluckydog
              properties:
                luckydog:
                  type: integer
        responses:
          200:
            description: successful!
        security:
        - token: [] 
    /user/{uid}/managePro/:
      post:
        tags:
          - management
        summary: project management
        description: get a list of project,and change user's project list
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - in: path
            name: uid
            description: user ID 
            required: true
            type: integer
          - name: POSTdata
            in: body
            description: data to change projects
            schema:
              required:
                - projectList
              properties:
                projectList:
                  type: array
                  items:
                    required:
                      - projectID
                    properties:
                      projectID:
                        type: integer
        responses:
          200:
            description: change it successfully
        security:
        - token: []  
    /user/{uid}/manageGroup/:
      post:
        tags:
          - management
        summary: superuser change member's group
        description: just receive a groupID  
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - in: path
            name: uid
            description: user ID
            required: true
            type: integer
          - name: POSTdata
            in: body
            description: groupID
            schema:
              required:
                - groupID
              properties:
                groupID:
                  type: integer
        responses:
          200:
            description: OK
        security:
        - token: []
    /user/{uid}/setRole/:
      post:
        tags:
          - management
        summary: superuser set user's role
        description: receive a number and change it
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - in: path
            name: uid
            description: user ID
            required: true
            type: integer
          - name: POSTdata
            in: body
            description: role
            schema:
              required:
                - role
              properties:
                role:
                  type: integer
        responses:
          200:
            description: OK
        security:
        - token: []
    /user/{uid}/setting/:
      get:
        tags:
         - management
        summary: get one's informattion
        description: get information by one's id
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - in: path
            name: uid
            description: userID
            required: true
            type: integer
        responses:
          200:
            description: OK
            schema:
              required:
                - name
                - email
                - tel
                - avatar
                - email_service
                - message
              properties:
                name:
                  type: string
                email:
                  type: string
                tel:
                  type: string
                avatar:
                  type: string
                email_service:
                  type: boolean
                message:
                  type: boolean
        security:
        - token: []
                  
      post:
        tags:
          - management
        summary: user's setting
        description: setting about message and email service
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - in: path
            name: uid 
            description: user ID
            required: true
            type: integer
          - name: POSTdata
            in: body
            description: message and email
            schema:
              required:
                - username
                - address
                - tel
                - message
                - email
              properties:
                username:
                  type: string
                address:
                  type: string
                tel:
                  type: string
                message:
                  type: boolean
                email:
                  type: boolean
        responses:
          200:
            description: OK
          401:
            description: this is others personal setting!
          402:
            description: please ger yourself information!/username can't be a empty string
          409:
            description: Username has existed
        security:
        - token: []
    /user/uploadAvatar/:
      post:
        tags:
          - management
        summary: upload a image and get a url,and set new url
        description: receive a image upload it to qiniu, and get a url,set it on database and return it
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - name: image
            in: body
            description: a image file
            required: true
            schema:
              type: string
        responses:
          200:
            description: OK
            schema:
              required:
                - url
              properties:
                url:
                  type: string
          403:
            description: upload failed
        
    /team/applyList/:
      get:
        tags:
          - management
        summary: get a list of who want join the "club"
        description: receive a token, verify it and return list
        consumes:
          - application/json
        produces:
          - application/json
        responses:
          200:
            description: OK
            schema:
              required:
                - list
              properties:
                list:
                  type: array
                  items:
                    required:
                      - userID
                      - userName
                      - userEmail
                    properties:
                      userID:
                        type: integer
                      userName:
                        type: string
                      userEmail:
                        type: string
          201:
            description: Application all done!
    /team/apply/{uid}/:
      delete:
        tags:
          - management
        summary: refuse application to join team
        description: receive a id and delete it 
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - in: path
            name: uid
            description: userID
            required: true
            type: integer
        responses:
          200:
            description: Ok
          403:
            description: other admin already refuse this one
    
    /team/invite/:
      get:
        tags:
          - management
        summary: Get a hash_id of team id
        description: get the request user's team id, and hash it, return url to prase
        consumes:
          - application/json
        produces:
          - application/json
        responses:
          200:
            description: OK
            schema:
              required:
                - invite_url
                - hash_id
              properties:
                invite_url:
                  type: string
                hash_id:
                  type: string
    
    /team/invite/{hash_id}/:
      get:
        tags:
          - management
        summary: resolve hash_id and get the team id
        description: receive a string and unhash it, return it
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - in: path
            name: hash_id
            type: string
            description: hash_id of team
            required: true
        responses:
          200:
            description: OK
            schema:
              required:
                - teamID
              properties:
                teamID:
                  type: integer
          402:
            description: resolve failed
   



   
    /feed/list/{page}/:
      get:
        tags:
          - feed
        summary: API for getting a list of feeds
        description: Use mq's receive service to get feed from different queue.
        produces:
          - application/json
        parameters:
          - in: path
            name: page
            description: page to get
            required: true
            type: string
        responses:
          200:
            description: feed list
            schema:
              required: 
                - dataList
                - hasNext
                - pageMax
                - pageNum
                - rowsNum
              properties:
                dataList:
                  type: array
                  items:
                    required:
                      - user
                      - acton
                      - source
                      - time
                      - split
                    properties:
                      user:
                        type: array
                        items:
                          required:
                            - name
                            - id
                            - avatar_url
                          properties:
                            name:
                              type: string
                            id:
                              type: integer
                            avatar_url:
                              type: string
                      acton:
                        type: string
                      source:
                        type: array
                        items:
                          required:
                            - kind_id
                            - object_id
                            - project_id
                            - name
                          properties:
                            kind_id:
                              type: integer
                            object_id:
                              type: integer
                            project_id:
                              type: integer
                              description: 没有为-1
                            name: 
                              type: string
                      time:
                        type: string
                        description: "yyyy-mm-dd-HH:MM:SS"
                      split:
                        type: boolean
                hasNext:
                  type: boolean
                pageMax: 
                  type: integer
                pageNum: 
                  type: integer
                rowsNum: 
                  type: integer
          401:
            description: none
          404:
            description: none
        security:
        - token: []
        
    /feed/list/{userid}/personal/{page}/:
      get:
        tags:
          - feed
        summary: API for getting a list of personal feeds
        description: Use mq's receive service to get feed from different queue.
        produces:
          - application/json
        parameters:
          - in: path
            name: userid
            required: true
            type: integer
          - in: path
            name: page
            description: page to get
            required: true
            type: string
        responses:
          200:
            description: feed list
            schema:
              required: 
                - dataList
                - hasNext
                - pageMax
                - pageNum
                - rowsNum
              properties:
                dataList:
                  type: array
                  items:
                    required:
                      - user
                      - acton
                      - source
                      - time
                      - split
                    properties:
                      user:
                        type: array
                        items:
                          required:
                            - name
                            - id
                            - avatar_url
                          properties:
                            name:
                              type: string
                            id:
                              type: integer
                            avatar_url:
                              type: string
                      acton:
                        type: string
                      source:
                        type: array
                        items:
                          required:
                            - kind_id
                            - object_id
                            - project_id
                            - name
                          properties:
                            kind_id:
                              type: integer
                            object_id:
                              type: integer
                            project_id:
                              type: integer
                              description: 没有为-1
                            name: 
                              type: string
                      time:
                        type: string
                        description: "yyyy-mm-dd-HH:MM:SS"
                      split:
                        type: boolean
                hasNext:
                  type: boolean
                pageMax: 
                  type: integer
                pageNum: 
                  type: integer
                rowsNum: 
                  type: integer
          401:
            description: role is nobody
          404:
            description: no user has this id 
        security:
        - token: []
        
        

    /user/attention/:
      post:
        tags:
          - message
        summary: post and you will pay attention to file or doc
        description: receive a fileID and add it to attention list
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - name: postData
            in: body
            description: file ID
            schema:
              required: 
                - fileID
                - fileKind
              properties:
                fileID:
                  type: integer
                fileKind:
                  type: integer
        responses:
          200:
            description: successful
          402:
            description: file not found! / file kind not find! / You already pay attention to this file!
        security:
        - token: []     
     
      get:
        tags:
          - message
        summary: get a list of user attenting file
        description: receive a token and return a list of file
        consumes:
          - application/json
        produces:
          - application/json
        responses:
          200:
            description: OK
            schema:
              required:
                - list
              properties:
                list:
                  type: array
                  items:
                    required:
                      - url
                      - fileID
                      - fileKind
                      - fileName
                      - username
                      - projectID
                      - projectName
                      - date
                    properties:
                      url:
                        type: string
                      fileID:
                        type: integer
                      fileKind:
                        type: integer
                      fileName:
                        type: string
                      username:
                        type: string
                      prijectId:
                        type: integer
                      projectName:
                        type: string
                      date:
                        type: string
      
      delete:
        tags:
          - message
        summary: post a filename and delete it
        description: find FILE in database and delete attention
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - name: POSTdata
            in: body
            description: filename
            schema:
              required:
                - fileName
                - fileKind
              properties:
                fileName:
                  type: string
        responses:
          200:
            description: OK
          403:
            description: file not exist!
    
    /message/list/:
      get:
        tags:
          - message
        summary: API for getting a list of massages
        description: Get a list of message by two ways.
        produces:
          - application/json
        parameters:
          - in: header
            name: kind
            description: KIND[1]hover[0]click
            required: true
            type: integer
        responses:
          200:
            description: message list
            headers:
              links:
                type: string
                description: next page & last page url
            schema:
              required:
                - list
              properties:
                list:
                  type: array
                  items:
                    required:
                      - sourceKind
                      - sourceID
                      - projectID
                      - fromName
                      - fromAvatar
                      - action
                      - time
                      - readed
                    properties:
                      sourceKind:
                        type: integer
                      sourceID:
                        type: integer
                      projectID:
                        type: integer
                      fromName:
                        type: string
                      fromAvatar:
                        type: string
                      time:
                        type: string
                      action:
                        type: string
                      readed:
                        type: boolean
          401:
            description: from user is gone.
        security:
        - token: []      
        
    /message/readAll/:
      post:
        tags:
          - message
        summary: click to read all messages
        description: verify and change all unreaded message
        consumes:
          - application/json
        produces:
          - application/json
        responses:
          200:
            description: OK
        security:
        - token: []
        
    /message/{username}/{mid}/:
      get:
        tags:
          - message
        summary: message information
        description: verify token and find id
        produces:
          - application/json
        parameters:
          - in: path
            name: mid
            description: messageID
            required: true
            type: integer
          - in: path
            name: username
            description: user's name to find user and verify
            required: true
            type: string
        responses:
          200:
            description: OK
            schema:
              required:
                - msgID
                - fromName
                - time
                - action
                - sourceID
                - sourceKind
              properties:
                msgID:
                  type: integer
                fromName:
                  type: string
                time:
                  type: string
                action:
                  type: string
                sourceID:
                  type: integer
                sourceKind:
                  type: integer
          401:
            description: verify failed
          402:
            description: user isn't exist
          403:
            description: message isn't exist
        security:
        - token: []      
       
        
            
    /status/new/:
      post:
        tags:
          - status
        summary: post a statu
        description: receive including and title 
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - name: POSTdata
            in: body
            description: content and title
            schema:
              required:
                - content
                - title
              properties:
                content:
                  type: string
                title:
                  type: string
        responses:
          200:
            description: OK
        security:
        - token: []
        
    /status/{sid}/:
      get:
        tags:
          - status
        summary: get information of statu
        description: content title time like and user
        produces:
          - application/json
        parameters:
          - in: path
            name: sid
            description: statu ID
            required: true
            type: integer
        responses:
          200:
            description: OK
            schema:
              required:
                - sid
                - title
                - content
                - time
                - likeCount
                - commentCount
                - userID
                - username
                - commentList
              properties:
                sid:
                  type: integer
                title:
                  type: string
                author_id:
                  type: integer
                content:
                  type: string
                time:
                  type: string
                likeCount:
                  type: integer
                iflike:
                  type: boolean
                userID:
                  type: integer
                username:
                  type: string
                commentList:
                  type: array
                  items:
                    required:
                      - cid
                      - username
                      - avatar
                      - time
                      - content
                    properties:
                      cid:
                        type: integer
                      username:
                        type: string
                      avatar:
                        type: string
                      time:
                        type: string
                      content:
                        type: string
        security:
        - token: []
      
      put:
        tags:
          - status
        summary: edit a statu
        description: edit
        produces:
          - application/json
        parameters:
          - in: path
            name: sid
            description: status ID
            required: true
            type: integer
        responses:
          200:
            description: statu edit successfully
        security:
        - token: []
      
      delete:
        tags:
          - status
        summary: delete a statu
        description: delete
        produces:
          - application/json
        parameters:
          - in: path
            name: sid
            description: status ID
            required: true
            type: integer
        responses:
          200:
            description: OK
          402:
            description: the statu has already been deleted
        security:
        - token: []
        
    /status/list/{page}:
      get:
        tags:
          - status
        summary: get a list of status
        description: one page have 20 status
        produces:
          - application/json
        parameters:
          - in: path
            name: page
            description: page number
            required: true
            type: integer
        responses:
          200:
            description: OK
            schema:
              required:
                - statuList
                - page
                - count
              properties:
                statuList:
                  type: array
                  items:
                    required:
                      - sid
                      - username
                      - uid
                      - time
                      - avatar
                      - title
                      - content
                      - likeCount
                      - iflike
                      - commentCount
                    properties:
                      sid:
                        type: integer
                      username:
                        type: string
                      uid:
                        type: integer
                      time:
                        type: string
                      avatar:
                        type: string
                      title:
                        type: string
                      content:
                        type: string
                      likeCount:
                        type: integer
                      iflike:
                        type: boolean
                      commentCount:
                        type: integer
                page: 
                  type: integer
                count: 
                  type: integer
        security:
        - token: []
        
    /status/{uid}/list/{page}/:
      get:
        tags:
          - status
        summary: get a list of one user status
        description: one page have 20 status
        produces:
          - application/json
        parameters:
          - in: path
            name: page
            description: page number
            required: true
            type: integer
          - in: path
            name: uid
            description: user ID
            required: true
            type: integer
        responses:
          200:
            description: OK
            schema:
              required:
                - statuList
              properties:
                statuList:
                  type: array
                  items:
                    required:
                      - sid
                      - time
                      - content
                      - likeCount
                      - iflike
                      - commentCount
                    properties:
                      sid:
                        type: integer
                      time:
                        type: string
                      content:
                        type: string
                      likeCount:
                        type: integer
                      iflike:
                        type: boolean
                      commentCount:
                        type: integer
                page: 
                  type: integer
                count:
                  type: integer
        security:
        - token: []
    /status/{sid}/like/:
      put:
        tags:
          - status
        summary: comment a statu
        description: verify and post 
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - in: path
            name: sid
            description: status ID
            required: true
            type: integer
          - name: POSTdata
            in: body
            description: post a new comment
            schema:
              required:
                - iflike
              properties:
                content:
                  type: boolean
                  description: 0 - don't like  1 - like 
        responses:
          200:
            description: OK
        security:
        - token: []
        
    /status/{sid}/comments/:
      post:
        tags:
          - status
        summary: comment a statu
        description: verify and post 
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - in: path
            name: sid
            description: status ID
            required: true
            type: integer
          - name: POSTdata
            in: body
            description: post a new comment
            schema:
              required:
                - content
              properties:
                content:
                  type: string
        responses:
          200:
            description: OK
          405:
            description: the statu is already deleted
        security:
        - token: []
        
    /status/{sid}/comment/{cid}/:
      delete:
        tags:
          - status
        summary: delete a comment by id
        description: admin
        produces:
          - application/json
        parameters:
          - in: path
            name: cid
            description: comment id
            required: true
            type: integer
          - in: path
            name: sid
            description: statu ID
            required: true
            type: integer
        responses:
          200:
            description: OK
          402:
            description: can't find
        security:
        - token: []
    
  
    /search/:
      post:
        tags:
          - search
        summary: Search API
        description: receive project and pattern
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - name: page
            in: path
            required: true
            description: page number[defualt = 1]
            type: integer
          - name: POSTdata
            in: body
            description: include pattern and projectID [projectID == 0 means all]
            schema:
              required:
                - pattern
                - projectID
              properties:
                pattern:
                  type: string
                projectID:
                  type: integer
        responses:
          200:
            description: OK
            schema:
              required:
                - list
                - count
                - pageMax
                - pageNow
                - hasNext
              properties:
                count:
                  type: integer
                pageMax:
                  type: integer
                pageNow:
                  type: integer
                hasNext:
                  type: boolean
                list:
                  type: array
                  items:
                    required:
                      - kind
                      - sourceID
                      - recordName
                      - projectID
                      - projectName
                      - creator
                      - time
                    properties:
                      kind:
                        type: integer
                      sourceID:
                        type: integer
                      recordName:
                        type: string
                      projectID:
                        type: integer
                      projectName:
                        type: string
                      creator:
                        type: string
                      time:
                        type: string
          403:
            description: projectmistake
        security:
        - token: []



################################## PROJECT ###################################
    /project/new/:
      post:
        tags:
          - project
        summary: build a new project
        description: admin can build a project by this API
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - name: POSTdata
            in: body
            description: required information to post a new project
            schema:
              required:
                - username
                - projectname
                - userlist
                - intro
              properties:
                username:
                  type: string
                projectname:
                  type: string
                userlist:
                  type: array
                  items:
                    required:
                      - userID
                    properties:
                      userID:
                        type: integer
                intro:
                  type: string
        responses:
          201:
            description: OK
          404:
            description: errmsg
        security:
        - token: []
    /project/{pid}/:
      get:
        tags:
          - project
        summary: get the name & including of introduction
        description: return a string
        produces:
          - application/json
        parameters:
          - in: path
            name: pid
            description: projectID
            required: true
            type: integer
        responses:
          200:
            description: OK
            schema:
              required:
                - intro
                - name
                - userCount
              properties:
                intro:
                  type: string
                name:
                  type: string 
                userCount:
                  type: integer 
          404:
            description: errmsg
        security:
        - token: []
      delete:
        tags:
          - project
        summary: delete a project
        description: only superuser
        produces:
          - application/json
        parameters:
          - in: path
            name: pid
            description: projectID
            required: true
            type: integer
        responses:
          200:
            description: OK
          404:
            description: errmsg
        security:
        - token: []
      post:
        tags:
          - project
        summary: edit introduction & name
        description: change introduction & name
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - in: path
            name: pid
            description: projectID
            required: true
            type: integer
          - name: POSTdata
            in: body
            description: change including
            schema:
              required:
                - intro
                - name
              properties:
                intro:
                  type: string
                name:
                  type: string
        responses:
          201:
            description: edit successfully
          404:
            description: errmsg
        security:
        - token: []
        
    /project/{pid}/member/:
      get:
        tags:
          - project
        summary: get a member list
        description: get
        produces:
          - application/json
        parameters:
          - in: path
            name: pid
            description: projectID
            required: true
            type: integer
        responses:
          200:
            description: OK
            schema:
              required:
                - memberList
              properties:
                memberList:
                  type: array
                  items:
                    required:
                      - userID
                      - username
                      - avatar
                      - group
                      - role
                    properties:
                      userID:
                        type: integer
                      username:
                        type: string
                      avatar:
                        type: string
                      group:
                        type: string
                      role: 
                        type: integer
        security:
        - token: []
      put:
        tags:
          - project
        summary: change the list of project members
        description: get groupID and list ,and change it
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - in: path
            name: pid
            description: projectID
            required: true
            type: integer
          - name: POSTdata
            in: body
            description: userlist
            schema:
              required:
                - userList
              properties:
                userList:
                  type: array
                  items:
                    type: integer
        responses:
          200:
            description: change it successfully
          404:
            description: errmsg    
        security:
        - token: []
        
    /project/{pid}/doc/{fid}/comments/:
      post:
        tags:
          - project
        summary: comment a doc
        description: verify and post 
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - in: path
            name: pid
            description: project ID
            required: true
            type: integer
          - in: path
            name: fid
            description: doc ID
            required: true
            type: integer
          - name: POSTdata
            in: body
            description: post a new comment
            schema:
              required:
                - content
              properties:
                content:
                  type: string
        responses:
          201:
            description: return cid
            schema:
              required: 
                - cid
              properties:
                cid:
                  type: integer
          404:
            description: errmsg
        security:
        - token: []
      get:
        tags:
          - project
        summary: get information of comments 
        description: get username,avatar,time,including
        produces:
          - application/json
        parameters:
          - in: path
            name: pid
            description: project ID
            required: true
            type: integer
          - in: path
            name: fid
            description: file ID
            required: true
            type: integer
        responses:
          200:
            description: OK
            schema:
              required:
                - commentList
                - count
              properties:
                commentList:
                  type: array
                  items:
                    required:
                      - username
                      - avatar
                      - time
                      - content
                      - id
                    properties:
                      username:
                        type: string
                      avatar:
                        type: string
                      time:
                        type: string
                      content:
                        type: string
                      id:
                        type: integer
                count:
                  type: integer
        security:
        - token: []
        
    /project/{pid}/doc/{fid}/comment/{cid}/:
      delete:
        tags:
          - project
        summary: delete a comment by id
        description: admin
        produces:
          - application/json
        parameters:
          - in: path
            name: cid
            description: comment id
            required: true
            type: integer
          - in: path
            name: pid
            description: project ID
            required: true
            type: integer
          - in: path
            name: fid
            description: file ID
            required: true
            type: integer
        responses:
          200:
            description: OK
          404:
            description: errmsg
        security:
        - token: []
      get:
        tags:
          - project
        summary: get a comment
        description: get
        produces:
          - application/json
        parameters:
          - in: path
            name: pid
            description: project ID
            required: true
            type: integer
          - in: path
            name: fid
            description: doc ID
            required: true
            type: integer
          - in: path
            name: cid
            description: comment id
            required: true
            type: integer
        responses:
          200:
            description: OK
            schema:
              required:
                - commentList
              properties:
                commentList:
                  type: array
                  items:
                    required:
                      - username
                      - avatar
                      - time
                      - content
                      - id
                    properties:
                      username:
                        type: string
                      avatar:
                        type: string
                      time:
                        type: string
                      content:
                        type: string
                      id:
                        type: integer
          404:
            description: errmsg
        security:
        - token: []

    /project/{pid}/file/{fid}/comments/:
      get:
        tags:
          - project
        summary: get a list of comment
        description: get
        produces:
          - application/json
        parameters:
          - in: path
            name: pid
            description: project ID
            required: true
            type: integer
          - in: path
            name: fid
            description: file ID
            required: true
            type: integer
        responses:
          200:
            description: OK
            schema:
              required:
                - commentList
                - count
              properties:
                commentList:
                  type: array
                  items:
                    required:
                      - username
                      - avatar
                      - time
                      - content
                      - id
                    properties:
                      username:
                        type: string
                      avatar:
                        type: string
                      time:
                        type: string
                      content:
                        type: string
                      id:
                        type: integer
                count:
                  type: integer
                  description: 一共有多少条评论（所以有多少页你要自己算哦）
        security:
        - token: []
      post:
        tags:
          - project
        summary: comment a file
        description: verify and post 
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - in: path
            name: pid
            description: project ID
            required: true
            type: integer
          - in: path
            name: fid
            description: file ID
            required: true
            type: integer
          - name: POSTdata
            in: body
            description: post a new comment
            schema:
              required:
                - content
              properties:
                content:
                  type: string
        responses:
          201:
            description: return cid
            schema:
              required: 
                - cid
              properties:
                cid:
                  type: integer
          404:
            description: errmsg
        security:
        - token: []
        
    /project/{pid}/file/{fid}/comment/{cid}/:
      get:
        tags:
          - project
        summary: get information of a comment by id
        description: get username,avatar,time,including
        produces:
          - application/json
        parameters:
          - in: path
            name: cid
            description: comment id
            required: true
            type: integer
          - in: path
            name: pid
            description: project ID
            required: true
            type: integer
          - in: path
            name: fid
            description: file ID
            required: true
            type: integer
        responses:
          200:
            description: OK
            schema:
              required:
                - username
                - avatar
                - time
                - content
              properties:
                username:
                  type: string
                avatar:
                  type: string
                time:
                  type: string
                content:
                  type: string
          404:
            description: errmsg
        security:
        - token: []
      delete:
        tags:
          - project
        summary: delete a comment by id
        description: admin
        produces:
          - application/json
        parameters:
          - in: path
            name: cid
            description: comment id
            required: true
            type: integer
          - in: path
            name: pid
            description: project ID
            required: true
            type: integer
          - in: path
            name: fid
            description: file ID
            required: true
            type: integer
        responses:
          200:
            description: OK
          404:
            description: errmsg
        security:
        - token: []


    /folder/filetree/<int:pid>/:
      get:
        tags:
          - project
        summary: API for get the file_tree for a project
        description: get the file_tree for a project
        parameters:
          - in: path
            name: pid
            description: the ID of project
            required: true
            type: integer
        responses:
          200:
            description: get it
            schema:
              required:
                - filetree
              properties:
                filetree:
                  type: string
                  description: the filetree of this project;
          401:
            description: forbidden
          404:
            description: errmsg
        security:
        - token: []
      put:
        tags:
          - project
        summary: API for update the filetree
        parameters:
          - in: path
            name: pid
            description: the ID of project
            required: true
            type: integer
          - name: filetree
            in: body
            description: the filetree you want to update
            schema:
              required:
                - filetree
              properties:
                filetree:
                  type: string
                  description: the filetree you want to update
        responses:
          200:
            description: update
          401:
            description: forbidden
          404:
            description: errmsg
        security:
        - token: []

    /folder/doctree/<int:pid>/:
      get:
        tags:
          - project
        summary: API for get the doc_tree for a project
        description: get the doc_tree for a project
        parameters:
          - in: path
            name: pid
            description: the ID of project
            required: true
            type: integer
        responses:
          200:
            description: get it
            schema:
              required:
                - doctree
              properties:
                doctree:
                  type: string
                  description: the doctree of this project;
          401:
            description: forbidden
          404:
            description: errmsg
        security:
        - token: []
      put:
        tags:
          - project
        summary: API for update the filetree
        parameters:
          - in: path
            name: pid
            description: the ID of project
            required: true
            type: integer
          - name: doctree
            in: body
            description: the filetree you want to update
            schema:
              required:
                - doctree
              properties:
                doctree:
                  type: string
                  description: the filetree you want to update
        responses:
          200:
            description: update
          401:
            description: forbidden
          404:
            description: errmsg
        security:
        - token: []



################################# FILE ###########################################
    /folder/file/:
      post:
        tags:
          - file
        summary: API for create a new folder of file
        description: create a new folder of file
        parameters:
          - name: data
            in: body
            schema:
              required:
                - foldername
                - project_id
              properties:
                foldername:
                  type: string
                  description: the name you will use for new folder
                project_id:
                  type: integer
                  description: which project the folder belong to
        responses:
          201:
            description: create it
            schema:
              required:
                - id
              properties:
                id:
                  type: integer
                  description: the id of the folder you create
          401:
            description: forbidden
          500:
            description: server error
        security:
        - token: []
        
        
    /folder/file/{id}/:    
      put:
        tags:
          - file
        summary: the API for update the folder's name
        description:  update the folder's name
        parameters:
          - in: path
            name: id
            type: integer
            description: which folder you want to change name
            required: true
          - name: data
            in: body
            schema:
              required:
                - foldername
              properties:
                foldername:
                  type: string
                  description: the name you will change for folder for file
        responses:
          200:
            description: update
          401:
            description: forbidden
          500:
            description: errmsg
        security:
        - token: []
      delete:
        tags:
          - file
        summary: the API for delete a folder
        description:  delete a folder
        parameters:
          - in: path
            name: id
            type: integer
            description: which folder you want to delete
            required: true
          - name: data
            description: 详细信息看下一行的Model，传入两个列表，包含这个文件夹里的内容的ID，当前文件夹的id一起放到folder里边吧。
            in: body
            schema:
              required:
                - folder
                - file
              properties:
                folder:
                  type: array
                  description: the children folders' id of this folder
                file:
                  type: array
                  description: the children files' id of this folder
        responses:
          200:
            description: delete
          401:
            description: forbidden
          404:
            description: errmsg
        security:
        - token: []

    /folder/file/children/:
      post:
        tags:
          - file
        summary: API for get a folder of file
        description: get a folder of file
        parameters: 
          - name: data
            description:  详细信息看下一行的Model，传入两个列表，包含这个文件夹里的内容的ID。
            in: body
            schema:
              required:
                - folder
                - file
              properties:
                folder:
                  type: array
                  description: the children folders' id of this folder
                file:
                  type: array
                  description: the children files' id of this folder
        responses:
          200:
            description: get it
            schema:
              required:
                - FolderList
                - FileList
              properties:
                FolderList:
                  type: array
                  description: children folders of this folder
                  items:
                    required:
                      - id
                      - name
                    properties: 
                      id:
                        type: integer
                        description: the id of folder
                      name: 
                        type: string
                        description: the name of folder
                FileList:
                  type: array
                  description: children files of this folder
                  items:
                    required:
                      - id
                      - name
                      - creator
                      - url
                      - create_time
                    properties:
                      id:
                        type: integer
                        description: the id of file
                      name: 
                        type: string
                        description: the name of file
                      creator:
                        type: string
                        description: the creator of this file
                      url:
                        type: string
                        description: download url for file
                      create_time:
                        type: string
                        description: the create_time
          401:  
            description: forbidden
          404:
            description: errmsg
        security:
        - token: []

    /folder/doc/:
      post:
        tags:
          - file
        summary: API for create a new folder of doc
        description: create a new folder of doc
        parameters:
          - name: data
            in: body
            schema:
              required:
                - foldername
                - project_id
              properties:
                foldername:
                  type: string
                  description: the name you will use for new folder for doc
                project_id:
                  type: integer
                  description: which project the folder belong to
        responses:
          201:
            description: create it
            schema:
              required:
                - id
              properties:
                id:
                  type: integer
                  description: the id of the folder you create
          401:
            description: forbidden
          404:
            description: errmsg
        security:
        - token: []
        

    /folder/doc/{id}/:
      put:
        tags:
          - file
        summary: the API for update the folder's name
        description:  update the folder's name
        parameters:
          - in: path
            name: id
            type: integer
            description: which folder you want to change name
            required: true
          - name: data
            in: body
            schema:
              required:
                - foldername
              properties:
                foldername:
                  type: string
                  description: the name you will change for folder for file
        responses:
          200:
            description: update
          401:
            description: forbidden
          404:
            description: errmsg
        security:
        - token: []
      delete:
        tags:
          - file
        summary: the API for delete a folder
        description:  delete a folder
        parameters:
          - in: path
            name: id
            type: integer
            description: which folder you want to delete
            required: true
          - name: data
            description: 详细信息看下一行的Model，传入两个列表，包含这个文件夹里的内容的ID。
            in: body
            schema:
              required:
                - folder
                - doc
              properties:
                folder:
                  type: array
                  description: the children folders' id of this folder
                doc:
                  type: array
                  description: the children files' id of this folder
        responses:
          200:
            description: delete
          401:
            description: forbidden
          404:
            description: errmsg
        security:
        - token: []
    /folder/doc/children/:
      post:
        tags:
          - file
        summary: API for get a folder for md
        description: get a folder for md
        parameters: 
          - name: data
            description: 详细信息看下一行的Model，传入两个列表，包含这个文件夹里的内容的ID。
            in: body
            schema:
              required:
                - folder
                - doc
              properties:
                folder:
                  type: array
                  description: the children folders' id of this folder
                doc:
                  type: array
                  description: the children files' id of this folder
        responses:
          200:
            description: get it
            schema:
              required:
                - FolderList
                - DocList
              properties:
                FolderList:
                  type: array
                  description: children folders of this folder
                  items:
                    required:
                      - id
                      - name
                    properties: 
                      id:
                        type: integer
                        description: the id of folder
                      name: 
                        type: string
                        description: the name of folder
                DocList:
                  type: array
                  description: children md of this folder
                  items:
                    required:
                      - id
                      - name
                      - lastcontent
                    properties:
                      id:
                        type: integer
                        description: the id of file
                      name: 
                        type: string
                        description: the name of file
                      lastcontent:
                        type: string
                        description: 最新内容可以用来做封面
          401:  
            description: forbidden
          404:
            description: errmsg
        security:
        - token: []
        
    /editor/image/:
      post:
        tags:
          - file
        summary: editor upload image
        description: upload image in editor
        parameters:
          - name: data
            in: body
            schema:
              required:
                - file
                - project_id
              properties:
                file:
                  type: string
                  description: the file you want to uploda
                project_id:
                  type: integer
                  description: which project this file belong to
        responses:
          200:
            description: return image url
            schema:
              required:
                - image_url
              properties:
                image_url:
                  type: string
          500:
            description: errmsg
        security:
        - token: []

    /file/file/:
      post:
        tags:
          - file
        summary: API for uploda a new file
        description: uploda a new file
        parameters:
          - name: data
            in: body
            schema:
              required:
                - file
                - project_id
              properties:
                file:
                  type: string
                  description: the file you want to uploda
                project_id:
                  type: integer
                  description: which project this file belong to
        responses:
          201:
            description: create it
            schema:
              required:
                - id
              properties:
                id:
                  type: integer
                  description: the id of the file you create
          401:
            description: forbidden
          404:
            description: errmsg
        security:
        - token: []

    /file/file/{id}/:
      delete:
        tags:
          - file
        summary: the API for delete a file
        description:  delete a file
        parameters:
          - in: path
            name: id
            type: integer
            description: which file you want to delete
            required: true
        responses:
          200:
            description: delete
          401:
            description: forbidden
          404:
            description: errmsg
        security:
        - token: []
      put:
        tags:
          - file
        summary: the API to update file
        description: update file
        parameters:
          - in: path
            name: id
            description: id of file
            type: integer
            required: true
          - name: data
            in: body
            schema:
              required:
                - FileName
              properties:
                DocName:
                  type: string
                  description: the name which you will use
        responses:
          200:
            description: change it
          401:
            description: forbidden
          404:
            description: errmsg
        security:
        - token: []

    /file/doc/:
      post:
        tags:
          - file
        summary: API for create a new doc
        description: create a new doc
        parameters:
          - name: data
            in: body
            schema:
              required:
                - mdname
                - content
                - project_id
              properties:
                mdname:
                  type: string
                  description: the name of md
                content:
                  type: string
                  description: the content of this md
                project_id:
                  type: integer
                  description: which project this md belong to
        responses:
          201:
            description: create it
            schema:
              required:
                - id
              properties:
                id:
                  type: integer
                  description: the id of the md you create
          401:
            description: forbidden
          404:
            description: errmsg
        security:
        - token: []

    /file/doc/{id}/:
      get:
        tags:
          - file
        summary: get the content of a doc
        description: get the content of a doc
        parameters:
          - in: path
            name: id
            type: integer
            description: the doc you want to get
            required: true
        responses:
          200:
            description: give the information of this doc
            schema:
              required:
                - name
                - lasteditor
                - creator
                - conetnt
                - create_time
              properties:
                name: 
                  type: string
                  description: the name of doc
                creator:
                  type: string
                  description: the creator of this doc
                conetnt:
                  type: string
                  description: the content of this doc
                lasteditor:
                  type: string
                  description: the last user who edit this doc
                create_time:
                  type: string
                  description: the create_time
          401:
            description: forbidden
          404:
            description: errmsg
        security:
          - token: []
      delete:
        tags:
          - file
        summary: the API for delete a doc
        description:  delete a doc
        parameters:
          - in: path
            name: id
            type: integer
            description: which doc you want to delete
            required: true
        responses:
          200:
            description: delete
          401:
            description: forbidden
          404:
            description: errmsg
        security:
        - token: []
      put:
        tags:
          - file
        summary: the API to update doc
        description: update doc
        parameters:
          - in: path
            name: id
            description: id of doc
            type: integer
            required: true
          - name: data
            in: body
            schema:
              required:
                - DocName
                - conetnt
              properties:
                DocName:
                  type: string
                  description: the name which you will use
                content:
                  type: string
                  description: the new content of doc
        responses:
          200:
            description: change it
          401:
            description: forbidden
          404:
            description: errmsg
        security:
        - token: []
        
    /project/{id}/re/:
      get:
        tags:
          - file
        summary: API for get re
        description: get re
        parameters: 
          - in: path
            name: id
            description: project 的ID
            required: true
            type: integer
        responses:
          200:
            description: get it
            schema:
              required:
                - FileList
                - DocList
              properties:
                FileList:
                  type: array
                  description: children files of this folder
                  items:
                    required:
                      - id
                      - name
                      - creator
                      - url
                      - create_time
                      - delete_time
                    properties:
                      id:
                        type: integer
                        description: the id of file
                      name: 
                        type: string
                        description: the name of file
                      creator:
                        type: string
                        description: the creator of this file
                      url:
                        type: string
                        description: download url for file
                      create_time:
                        type: string
                        description: the create_time
                      delete_time:
                        type: string
                        description: the delete_time
                FolderList:
                  type: array
                  description: children md of this folder
                  items:
                    required:
                      - id
                      - name
                      - lastcontent
                    properties:
                      id:
                        type: integer
                        description: the id of file
                      name: 
                        type: string
                        description: the name of file
                      lastcontent:
                        type: string
                        description: 最新内容可以用来做封面
          401:  
            description: forbidden
          404:
            description: errmsg
        security:
        - token: []
      put:
        tags:
          - file
        summary: put back to the original position
        description: put back to the original position
        parameters:
          - in: path
            name: id
            description: project 的ID
            required: true
            type: integer
          - name: data
            description: 详细信息看下一行的Model，传入两个列表，包含要恢复的ID。
            in: body
            schema:
              required:
                - file
                - doc
              properties:
                file:
                  type: array
                  description: 恢复的文件的ID
                doc:
                  type: array
                  description: 恢复的文档的ID
        responses:
          200:
            description: recover
          401:  
            description: forbidden
          404:
            description: errmsg
        security:
        - token: []
      delete:
        tags:
          - file
        summary: really delete
        description: really delete
        parameters: 
          - in: path
            name: id
            description: project 的ID
            required: true
            type: integer
          - name: data
            description: 详细信息看下一行的Model，传入两个列表，包含要删除的ID。
            in: body
            schema:
              required:
                - file
                - doc
              properties:
                file:
                  type: array
                  description: 删除的文件的ID
                doc:
                  type: array
                  description: 删除的文档的ID
        responses:
          200:
            description: delete
          401:  
            description: forbidden
          404:
            description: errmsg
        security:
        - token: []



  ########
  
  # DEFINITIONS
  definitions:
  
    FeedRETURN:
      properties:
        datalist:
          type: array
          items: 
            $ref: '#/definitions/FeedRetMeta'
            
    
    FeedRetMeta:
      properties:
        source:
          type: object
          $ref: '#/definitions/FeedSource'
        user:
          type: object
          $ref: '#/definitions/FeedUser'
        action:
          type: string
        feedid: 
          type: integer
        ifsplit:
          type: boolean
        timeday:
          type: string
        timehm:
          type: string
        
        
    FeedSource:
      properties:
        kind_id:
          type: integer
        object_id:
          type: integer
        object_name:
          type: string
        project_id:
          type: integer
        project_name:
          type: string
        
    FeedUser:
      properties:
        avater_url: 
          type: string
        id:
          type: integer
        name:
          type: string
            
          
          
          
  
    User:
      required:
        - id
        - name
        - email
        - avatar
        - tel
        - role
        - email_service
        - message
        - team_id
        - group_id
        - status
        - receiveMsgs
        - feeds
      properties:
        id:
          type: integer
          description: primary key
        name:
          type: string
          description: username
        email:
          type: string
          description: email address
        avatar:
          type: string
          description: avatar url
        tel:
          type: string
          description: telephone number
        role:
          type: integer
          description: role,100->superuser
        email_service:
          type: boolean
          description: open email_service or not
        message:
          type: boolean
          description: receive message or not
        team_id:
          type: integer
          description: foreign key of TEAM
        group_id:
          type: integer
          description: foreign key of GROUP
        status:
          description: status
        receiveMsgs: 
          description: messages
        feeds:
          description: feeds
    Team:
      required:
        - id
        - name
        - count
        - time
        - creator
        - users
      properties:
        id:
          type: integer
          description: primary key
        name:
          type: string
          description: team name
        count:
          type: integer
          description: member count
        time:
          type: string
          description: time to create
        creator:
          type: integer
          description: foreign key of who create the team
        users:
          description: users
    Group:
      required:
        - id
        - name
        - order
        - count
        - leader
        - time
        - users
      properties:
        id:
          type: integer
          description: primary key
        name:
          type: string
          description: group name
        order:
          type: integer
          description: order to sort the groups
        count:
          type: integer
          description: member count
        leader:
          type: integer
          description: foreign key of who lead this team in this year 
        time:
          type: string
          description: time to print[use the time tools to get it]
        users:
          description: users
          
    Project:
      required:
        - id
        - name
        - intro
        - time
        - count
        - team_id
        - filetree
        - doctree
      properties:
        id:
          type: integer
          description: primary key
        name:
          type: string
          description: project name
        intro:
          type: string
          description: project simple introduction
        time:
          type: string
          description: when this project was created
        count:
          type: integer
          description: user count
        team_id:
          type: integer
          description: foreign key of TEAM
        filetree:
          type: string
          description: file tree
        doctree:
          type: string
          description: doc tree
    
    Apply:
      required:
        - id
        - user_id
      properties:
        id:
          type: integer
          description: primary_key
        user_id:
          type: integer
          description: foreign key for User
    
    User2Project:
      required:
        - id
        - user_id
        - project_id
      properties:
        id:
          type: integer
          description: primary key
        user_id:
          type: integer
          description: foreign key of USER
        projetc_id:
          type: integer
          description: foreign key of PROJECT
    Statu:
      required:
        - id
        - content
        - title
        - time
        - like
        - comment
        - user_id
        - comments
      properties:
        id:
          type: integer
          description: primary key
        content:
          type: string
          description: including of statu
        title:
          type: string
          description: title
        time:
          type: string
          description: the time you post this statu
        like:
          type: string
          description: the number your statu get LIKE!
        comment:
          type: string
          description: the number your statu's comment
        user_id:
          type: integer
          description: foreign key
        comments:
          description: comments
    
    FolderForFile:
      required:
        - id
        - name
        - create_time
        - create_id
        - project_id
        - re
      properties:
        id: 
          type: integer
          description: primary key
        name:
          type: string
          description: folder name
        create_time:
          type: string
          description: time to create
        create_id:
          type: integer
          description: creator
        project_id:
          type: integer
          description: foreign key
        re:
          type: boolean
    
    File:
      required:
        - id
        - url
        - filename
        - re
        - top
        - create_time
        - creator_id
        - project_id
      properties:
        id:
          type: integer
          description: primary key
        url:
          type: string
          description: URL of qiniu cloud
        filename:
          type: string
          description: filename
        re:
          type: boolean
        create_time:
          type: string
          description: create time
        creator_id:
          type: integer
          description: foreign key of this file's creator
        project_id:
          type: integer
          description: foreign key of PROJECT
        comments:
          description: comments
    Doc:
      required:
        - id
        - filename
        - content
        - re
        - top
        - create_time
        - editor_id
        - creator_id
        - project_id
        - comments
      properties:
        id:
          type: integer
          description: primary key
        filename:
          type: string
          description: file name
        content:
          type: string
          description: doc content
        re: 
          type: boolean
        top:
          type: boolean
        create_time:
          type: string
          description: create time
        editor_id:
          type: integer
          description: foreign key for User
        creator_id:
          type: integer
          description: foreign key for User
        project_id:
          type: integer
          description: foreign key for Project
        comments:
          description: comments
    Comment:
      required:
        - id
        - kind
        - content
        - time
        - creator
        - doc_id
        - statu_id
      properties:
        id:
          type: integer
          description: primary key
        kind:
          type: integer
          description: destination is file or statu  
        content:
          type: string
          description: comment including
        time:
          type: string
          description: post time
        creator:
          type: integer
          description: foreign key of poster
        doc_id:
          type: integer
          description: if you comment FILE
        statu_id:
          type: integer
          description: if you comment STATU
    Message:
      required:
        - id
        - time
        - action
        - kind
        - readed
        - from_id
        - receive_id
        - file_id
        - file_kind
      properties:
        id:
          type: integer
          description: primary key
        time:
          type: string
          description: birth time
        action:
          type: string
          description: such as 'LIKE','COMMENT','UPLOAD'...
        kind:
          type: integer
          description: FILE STATU or COMMENT
        readed:
          type: boolean
          description: readed or not readed
        from_id:
          type: integer
          description: foreign key of who make this message
        receive_id:
          type: integer
          description: who will receive it 
        file_id:
          type: integer
          description: if from file
        file_kind:
          type: integer
          description: 0 for doc, 1 for file
    User2File:
      required:
        - id
        - user_id
        - file_id
        - file_kind
      properties:
        id: 
          type: integer
          description: primary key
        user_id:
          type: integer
          description: foreign key for User
        file_id:
          type: integer
          description: foreign key for File
        file_kind:
          type: integer
          description: 0 for doc, 1 for file⏎