cp-organization-management-gateway/docs/swagger.yaml

definitions:
  base.HTTPError:
    properties:
      code:
        example: 500
        format: int
        type: integer
      message:
        example: status bad request
        type: string
    type: object
  v1.CreateManagementUserReply:
    properties:
      uid:
        type: integer
    type: object
  v1.LoginBody:
    properties:
      key:
        type: string
      password:
        type: string
      user:
        type: string
    type: object
  v1.LoginData:
    properties:
      organization:
        type: string
      refresh_token:
        type: string
      token:
        type: string
      uid:
        type: integer
      user:
        type: string
    type: object
  v1.LoginResponse:
    properties:
      code:
        default: 0
        description: 返回码
        format: int
        type: integer
      data:
        $ref: '#/definitions/v1.LoginData'
        type: object
      message:
        default: success
        description: 消息
        type: string
    type: object
  v1.ManagementLogItem:
    properties:
      action:
        description: 行为
        type: string
      created_at:
        description: 时间
        type: string
      id:
        description: 日志id
        type: integer
      module:
        description: 模块
        type: string
      origin:
        description: 修改前信息
        type: string
      target:
        description: 修改后信息
        type: string
      uid:
        description: 账号id
        type: integer
      username:
        description: 账号名
        type: string
    type: object
  v1.ManagementLogListReply:
    properties:
      list:
        items:
          $ref: '#/definitions/v1.ManagementLogItem'
        type: array
      page:
        type: integer
      total:
        type: integer
    type: object
  v1.ManagementLogListResponse:
    properties:
      code:
        default: 0
        description: 返回码
        format: int
        type: integer
      data:
        $ref: '#/definitions/v1.ManagementLogListReply'
        type: object
      message:
        default: success
        description: 消息
        type: string
    type: object
  v1.RbacGroupAddBody:
    properties:
      name:
        type: string
      node_list:
        type: string
    type: object
  v1.RbacGroupAddReply:
    properties:
      id:
        type: integer
    type: object
  v1.RbacGroupAddResponse:
    properties:
      code:
        default: 0
        description: 返回码
        format: int
        type: integer
      data:
        $ref: '#/definitions/v1.RbacGroupAddReply'
        type: object
      message:
        default: success
        description: 消息
        type: string
    type: object
  v1.RbacGroupDelResponse:
    properties:
      code:
        default: 0
        description: 返回码
        format: int
        type: integer
      message:
        default: success
        description: 消息
        type: string
    type: object
  v1.RbacGroupItem:
    properties:
      id:
        type: integer
      name:
        type: string
    type: object
  v1.RbacGroupListReply:
    properties:
      list:
        items:
          $ref: '#/definitions/v1.RbacGroupItem'
        type: array
    type: object
  v1.RbacGroupListResponse:
    properties:
      code:
        default: 0
        description: 返回码
        format: int
        type: integer
      data:
        $ref: '#/definitions/v1.RbacGroupListReply'
        type: object
      message:
        default: success
        description: 消息
        type: string
    type: object
  v1.RbacGroupUpdateBody:
    properties:
      id:
        type: integer
      name:
        type: string
      node_list:
        type: string
    type: object
  v1.RbacGroupUpdateResponse:
    properties:
      code:
        default: 0
        description: 返回码
        format: int
        type: integer
      message:
        default: success
        description: 消息
        type: string
    type: object
  v1.RbacNodeItem:
    properties:
      childs:
        items:
          $ref: '#/definitions/v1.RbacNodeItem'
        type: array
      id:
        type: integer
      method:
        type: string
      name:
        type: string
      object:
        type: string
      pid:
        type: integer
      resource:
        type: string
      router:
        type: string
      select:
        type: boolean
    type: object
  v1.RbacNodeListReply:
    properties:
      list:
        items:
          $ref: '#/definitions/v1.RbacNodeItem'
        type: array
    type: object
  v1.RbacNodeListResponse:
    properties:
      code:
        default: 0
        description: 返回码
        format: int
        type: integer
      data:
        $ref: '#/definitions/v1.RbacNodeListReply'
        type: object
      message:
        default: success
        description: 消息
        type: string
    type: object
  v1.TokenResponse:
    properties:
      code:
        default: 0
        description: 返回码
        format: int
        type: integer
      data:
        type: string
      message:
        default: success
        description: 消息
        type: string
      refresh_token:
        type: string
    type: object
  v1.UserCreateBody:
    properties:
      email:
        type: string
      group_id:
        type: integer
      name:
        description: 姓名
        type: string
      password:
        type: string
      phone:
        type: string
      username:
        description: 账户名
        type: string
      zones:
        type: string
    type: object
  v1.UserCreateResponse:
    properties:
      code:
        default: 0
        description: 返回码
        format: int
        type: integer
      data:
        $ref: '#/definitions/v1.CreateManagementUserReply'
        type: object
      message:
        default: success
        description: 消息
        type: string
    type: object
  v1.UserDelResponse:
    properties:
      code:
        default: 0
        description: 返回码
        format: int
        type: integer
      message:
        default: success
        description: 消息
        type: string
    type: object
  v1.UserInfoReply:
    properties:
      email:
        type: string
      group_id:
        description: 所属角色
        type: integer
      group_name:
        type: string
      id:
        type: integer
      name:
        type: string
      node_list:
        description: 所拥有的权限
        items:
          $ref: '#/definitions/v1.RbacNodeItem'
        type: array
      phone:
        type: string
      username:
        type: string
      zone_list:
        items:
          $ref: '#/definitions/v1.ZoneItemSelect'
        type: array
    type: object
  v1.UserInfoResponse:
    properties:
      code:
        default: 0
        description: 返回码
        format: int
        type: integer
      data:
        $ref: '#/definitions/v1.UserInfoReply'
        type: object
      message:
        default: success
        description: 消息
        type: string
    type: object
  v1.UserItem:
    properties:
      email:
        type: string
      id:
        type: integer
      name:
        type: string
      phone:
        type: string
      username:
        type: string
      zones:
        items:
          type: string
        type: array
    type: object
  v1.UserListReply:
    properties:
      list:
        items:
          $ref: '#/definitions/v1.UserItem'
        type: array
      page:
        type: integer
      total:
        type: integer
    type: object
  v1.UserListResponse:
    properties:
      code:
        default: 0
        description: 返回码
        format: int
        type: integer
      data:
        $ref: '#/definitions/v1.UserListReply'
        type: object
      message:
        default: success
        description: 消息
        type: string
    type: object
  v1.UserUpdateBody:
    properties:
      email:
        type: string
      group_id:
        type: integer
      id:
        type: integer
      name:
        description: 姓名
        type: string
      password:
        type: string
      phone:
        type: string
      username:
        description: 账户名
        type: string
      zones:
        type: string
    type: object
  v1.UserUpdateResponse:
    properties:
      code:
        default: 0
        description: 返回码
        format: int
        type: integer
      message:
        default: success
        description: 消息
        type: string
    type: object
  v1.ZoneAddBody:
    properties:
      parent_zone_code:
        type: string
      zone_name:
        type: string
    type: object
  v1.ZoneAddReply:
    properties:
      zone_code:
        type: string
    type: object
  v1.ZoneAddResponse:
    properties:
      code:
        default: 0
        description: 返回码
        format: int
        type: integer
      data:
        $ref: '#/definitions/v1.ZoneAddReply'
        type: object
      message:
        default: success
        description: 消息
        type: string
    type: object
  v1.ZoneDelResponse:
    properties:
      code:
        default: 0
        description: 返回码
        format: int
        type: integer
      message:
        default: success
        description: 消息
        type: string
    type: object
  v1.ZoneItem:
    properties:
      childs:
        items:
          $ref: '#/definitions/v1.ZoneItem'
        type: array
      parent_zone_code:
        type: string
      zone_code:
        type: string
      zone_name:
        type: string
    type: object
  v1.ZoneItemSelect:
    properties:
      childs:
        items:
          $ref: '#/definitions/v1.ZoneItemSelect'
        type: array
      parent_zone_code:
        type: string
      select:
        type: boolean
      zone_code:
        type: string
      zone_name:
        type: string
    type: object
  v1.ZoneListReply:
    properties:
      list:
        items:
          $ref: '#/definitions/v1.ZoneItem'
        type: array
    type: object
  v1.ZoneListResponse:
    properties:
      code:
        default: 0
        description: 返回码
        format: int
        type: integer
      data:
        $ref: '#/definitions/v1.ZoneListReply'
        type: object
      message:
        default: success
        description: 消息
        type: string
    type: object
  v1.ZoneUpdateBody:
    properties:
      parent_zone_code:
        type: string
      zone_code:
        type: string
      zone_name:
        type: string
    type: object
  v1.ZoneUpdateResponse:
    properties:
      code:
        default: 0
        description: 返回码
        format: int
        type: integer
      message:
        default: success
        description: 消息
        type: string
    type: object
info:
  contact: {}
  description: This is a gateway server. On the page, you can go to do testing for every API.
  license: {}
  title: Project cp-organization-management-gateway's APIs
  version: "1.1"
paths:
  /api/v1/log/list:
    get:
      consumes:
      - application/json
      description: 获取日志列表
      parameters:
      - description: token
        in: header
        name: token
        required: true
        type: string
      - description: ' '
        in: query
        name: page
        type: integer
      - description: ' '
        in: query
        name: page_size
        type: integer
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.ManagementLogListResponse'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/base.HTTPError'
      summary: 获取日志列表
      tags:
      - 操作日志
  /api/v1/system/rbac/group:
    post:
      consumes:
      - application/json
      description: 添加角色
      parameters:
      - description: token
        in: header
        name: token
        required: true
        type: string
      - description: token
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/v1.RbacGroupAddBody'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.RbacGroupAddResponse'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/base.HTTPError'
      summary: 添加角色
      tags:
      - 系统管理-角色管理
    put:
      consumes:
      - application/json
      description: 修改角色
      parameters:
      - description: token
        in: header
        name: token
        required: true
        type: string
      - description: token
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/v1.RbacGroupUpdateBody'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.RbacGroupUpdateResponse'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/base.HTTPError'
      summary: 修改角色
      tags:
      - 系统管理-角色管理
  /api/v1/system/rbac/group/{id}:
    delete:
      consumes:
      - application/json
      description: 删除角色
      parameters:
      - description: token
        in: header
        name: token
        required: true
        type: string
      - description: token
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.RbacGroupDelResponse'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/base.HTTPError'
      summary: 删除角色
      tags:
      - 系统管理-角色管理
  /api/v1/system/rbac/group/list:
    get:
      consumes:
      - application/json
      description: 角色列表
      parameters:
      - description: token
        in: header
        name: token
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.RbacGroupListResponse'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/base.HTTPError'
      summary: 角色列表
      tags:
      - 系统管理-角色管理
  /api/v1/system/rbac/node/list:
    get:
      consumes:
      - application/json
      description: 权限节点列表
      parameters:
      - description: token
        in: header
        name: token
        required: true
        type: string
      - description: 不填返回所有，填了返回该角色下的权限
        in: query
        name: group_id
        type: integer
      - description: 填了groupid后，true：仅返回角色下的节点， false：返回所有节点，对属于该角色的节点作标记
        in: query
        name: only_select
        type: boolean
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.RbacNodeListResponse'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/base.HTTPError'
      summary: 权限节点列表
      tags:
      - 系统管理-角色管理
  /api/v1/system/user:
    post:
      consumes:
      - application/json
      description: 创建用户
      parameters:
      - description: token
        in: header
        name: token
        required: true
        type: string
      - description: ' '
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/v1.UserCreateBody'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.UserCreateResponse'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/base.HTTPError'
      summary: 创建用户
      tags:
      - 系统管理-用户管理
    put:
      consumes:
      - application/json
      description: 修改用户
      parameters:
      - description: token
        in: header
        name: token
        required: true
        type: string
      - description: ' '
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/v1.UserUpdateBody'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.UserUpdateResponse'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/base.HTTPError'
      summary: 修改用户
      tags:
      - 系统管理-用户管理
  /api/v1/system/user/{id}:
    delete:
      consumes:
      - application/json
      description: 删除用户
      parameters:
      - description: token
        in: header
        name: token
        required: true
        type: string
      - description: ' '
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.UserDelResponse'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/base.HTTPError'
      summary: 删除用户
      tags:
      - 系统管理-用户管理
  /api/v1/system/user/info/{id}:
    get:
      consumes:
      - application/json
      description: 用户详情
      parameters:
      - description: token
        in: header
        name: token
        required: true
        type: string
      - description: ' '
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.UserInfoResponse'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/base.HTTPError'
      summary: 用户详情
      tags:
      - 系统管理-用户管理
  /api/v1/system/user/list:
    get:
      consumes:
      - application/json
      description: 用户列表
      parameters:
      - description: token
        in: header
        name: token
        required: true
        type: string
      - description: ' '
        in: query
        name: page
        type: integer
      - description: ' '
        in: query
        name: page_size
        type: integer
      - description: '姓名或账户名 '
        in: query
        name: name
        type: string
      - description: '区域 '
        in: query
        name: zone
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.UserListResponse'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/base.HTTPError'
      summary: 用户列表
      tags:
      - 系统管理-用户管理
  /api/v1/token_refresh:
    put:
      consumes:
      - application/json
      description: 刷新token
      parameters:
      - description: token
        in: header
        name: token
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.TokenResponse'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/base.HTTPError'
      summary: 刷新token
      tags:
      - 用户
  /api/v1/user/login:
    post:
      consumes:
      - application/json
      description: 登录
      parameters:
      - description: 登录信息
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/v1.LoginBody'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.LoginResponse'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/base.HTTPError'
      summary: 登录
      tags:
      - 用户
  /api/v1/zone:
    post:
      consumes:
      - application/json
      description: 添加区域
      parameters:
      - description: token
        in: header
        name: token
        required: true
        type: string
      - description: ' '
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/v1.ZoneAddBody'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.ZoneAddResponse'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/base.HTTPError'
      summary: 添加区域
      tags:
      - 区域
    put:
      consumes:
      - application/json
      description: 修改区域
      parameters:
      - description: token
        in: header
        name: token
        required: true
        type: string
      - description: ' '
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/v1.ZoneUpdateBody'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.ZoneUpdateResponse'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/base.HTTPError'
      summary: 修改区域
      tags:
      - 区域
  /api/v1/zone/{zone_code}:
    delete:
      consumes:
      - application/json
      description: 删除区域
      parameters:
      - description: token
        in: header
        name: token
        required: true
        type: string
      - description: ' '
        in: path
        name: zone_code
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.ZoneDelResponse'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/base.HTTPError'
      summary: 删除区域
      tags:
      - 区域
  /api/v1/zone/list:
    get:
      consumes:
      - application/json
      description: 区域列表
      parameters:
      - description: token
        in: header
        name: token
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.ZoneListResponse'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/base.HTTPError'
      summary: 区域列表
      tags:
      - 区域
swagger: "2.0"