authorization-client/docs/swagger.yaml

basePath: /v1/api
definitions:
  admin.RoleItem:
    properties:
      created_at:
        description: 创建时间
        type: string
      created_by:
        description: 创建人
        type: string
      description:
        description: 描述
        type: string
      id:
        type: integer
      is_reserved:
        description: 是否可操作
        type: boolean
      name:
        description: 名称
        type: string
      permissions:
        description: 权限
        items:
          $ref: '#/definitions/base.ListMapItem'
        type: array
      status:
        description: '"enabled", "disabled"'
        type: string
      updated_at:
        description: 更新时间
        type: string
      users:
        description: 关联用户
        items:
          $ref: '#/definitions/base.ListMapItem'
        type: array
    type: object
  admin.UserItem:
    properties:
      avatar:
        description: 头像
        type: string
      created_at:
        description: 创建时间
        type: string
      email:
        description: 邮箱
        type: string
      id:
        type: integer
      is_reserved:
        type: boolean
      name:
        description: 名称
        type: string
      phone_number:
        description: 手机号
        type: string
      roles:
        description: 角色
        items:
          $ref: '#/definitions/base.ListMapItem'
        type: array
      status:
        allOf:
        - $ref: '#/definitions/base.Status'
        description: 状态 "enabled"｜"disabled"
      teams:
        description: 团队
        items:
          $ref: '#/definitions/base.ListMapItem'
        type: array
      updated_at:
        description: 更新时间
        type: string
    type: object
  admin_common.Request:
    properties:
      password:
        description: 密码
        maxLength: 18
        minLength: 6
        type: string
      username:
        description: 用户名
        maxLength: 15
        minLength: 5
        type: string
    required:
    - password
    - username
    type: object
  admin_role.CreateAdminRoleRequest:
    properties:
      description:
        description: 非必填，描述
        type: string
      name:
        description: 角色名称
        maxLength: 15
        minLength: 3
        type: string
    required:
    - name
    type: object
  admin_role.EnabledRoleItem:
    properties:
      description:
        type: string
      id:
        type: integer
      name:
        type: string
    type: object
  admin_role.EnabledRoles:
    properties:
      roles:
        items:
          $ref: '#/definitions/admin_role.EnabledRoleItem'
        type: array
    type: object
  admin_role.ListAdminRolesResponse:
    properties:
      items:
        items:
          $ref: '#/definitions/admin.RoleItem'
        type: array
      total_count:
        type: integer
    type: object
  admin_role.ToggleRequest:
    properties:
      status:
        allOf:
        - $ref: '#/definitions/base.Status'
        description: '"enabled"|"disabled"'
    required:
    - status
    type: object
  admin_role.UpdateRequest:
    properties:
      description:
        description: 非必填，描述
        type: string
      permissions:
        description: 权限
        items:
          type: integer
        type: array
      users:
        description: 管理员
        items:
          type: integer
        type: array
    type: object
  admin_user.EnabledUserItem:
    properties:
      id:
        type: integer
      name:
        type: string
    type: object
  admin_user.ListAdminUserResponse:
    properties:
      items:
        items:
          $ref: '#/definitions/admin.UserItem'
        type: array
      total_count:
        type: integer
    type: object
  admin_user.ToggleRequest:
    properties:
      status:
        allOf:
        - $ref: '#/definitions/base.Status'
        description: '"enabled"|"disabled"'
    required:
    - status
    type: object
  admin_user.UpdateRequest:
    properties:
      avatar:
        description: 头像
        type: string
      email:
        description: 邮箱
        type: string
      phone_number:
        description: 手机号
        type: string
      roles:
        description: 角色ID
        items:
          type: integer
        type: array
      teams:
        description: 团队ID
        items:
          type: integer
        type: array
    required:
    - email
    - phone_number
    type: object
  admin_user.UserRequest:
    properties:
      avatar:
        description: 头像
        type: string
      email:
        description: 邮箱
        type: string
      password:
        description: 密码
        maxLength: 18
        minLength: 6
        type: string
      phone_number:
        description: 手机号
        type: string
      roles:
        description: 角色ID
        items:
          type: integer
        type: array
      teams:
        description: 团队ID
        items:
          type: integer
        type: array
      username:
        description: 用户名
        maxLength: 15
        minLength: 5
        type: string
    required:
    - password
    - phone_number
    - username
    type: object
  authorization_client.AdminUserBase:
    properties:
      key:
        type: string
      value:
        type: string
    type: object
  authorization_client.AdminUserProfile:
    properties:
      address:
        type: string
      avatar:
        type: string
      bio:
        type: string
      birthdate:
        type: integer
      educations:
        items:
          $ref: '#/definitions/authorization_client.AdminUserProfileEducation'
        type: array
      email:
        type: string
      gender:
        type: integer
      phone_number:
        type: string
      social_links:
        items:
          $ref: '#/definitions/authorization_client.AdminUserProfileSocialLink'
        type: array
      website:
        type: string
      work_histories:
        items:
          $ref: '#/definitions/authorization_client.AdminUserProfileWorkHistory'
        type: array
    type: object
  authorization_client.AdminUserProfileEducation:
    properties:
      degree:
        type: string
      graduated:
        type: integer
      school:
        type: string
    type: object
  authorization_client.AdminUserProfileSocialLink:
    properties:
      platform:
        type: string
      url:
        type: string
    type: object
  authorization_client.AdminUserProfileWorkHistory:
    properties:
      company:
        type: string
      end_date:
        type: integer
      position:
        type: string
      responsibilities:
        type: string
      start_date:
        type: integer
    type: object
  authorization_client.GetAdminUser:
    properties:
      profile:
        $ref: '#/definitions/authorization_client.AdminUserProfile'
      roles:
        items:
          $ref: '#/definitions/authorization_client.AdminUserBase'
        type: array
      status:
        type: string
      teams:
        items:
          $ref: '#/definitions/authorization_client.AdminUserBase'
        type: array
      user_id:
        type: integer
      username:
        type: string
    type: object
  base.ListMapItem:
    properties:
      key:
        type: string
      value:
        type: string
    type: object
  base.Status:
    enum:
    - ENABLED
    - DISABLED
    - DELETED
    type: string
    x-enum-varnames:
    - ToggleEnabled
    - ToggleDisabled
    - ToggleDeleted
  common.UserInfo:
    properties:
      avatar:
        type: string
      email:
        type: string
      id:
        type: integer
      phone_number:
        type: string
      roles:
        items:
          $ref: '#/definitions/base.ListMapItem'
        type: array
      teams:
        items:
          $ref: '#/definitions/base.ListMapItem'
        type: array
      username:
        type: string
    type: object
  response.ApiResponse:
    properties:
      code:
        type: integer
      data: {}
      message:
        type: string
    type: object
externalDocs:
  description: OpenAPI
  url: https://swagger.io/resources/open-api/
host: localhost:8080
info:
  contact:
    email: support@swagger.io
    name: API Support
    url: http://www.swagger.io/support
  description: This is a sample server celler server.
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: http://swagger.io/terms/
  title: Swagger Example API
  version: "1.0"
paths:
  /v1/api/admin/login:
    post:
      consumes:
      - application/json
      description: 登录API
      parameters:
      - description: 请求body
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/admin_common.Request'
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            allOf:
            - $ref: '#/definitions/response.ApiResponse'
            - properties:
                data:
                  $ref: '#/definitions/common.UserInfo'
              type: object
        "400":
          description: 请求错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "500":
          description: 内部错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
      summary: 登录
      tags:
      - Common
  /v1/api/admin/profile:
    get:
      consumes:
      - application/json
      description: 查询个人信息
      parameters:
      - description: Bearer 用户令牌
        in: header
        name: Authorization
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            allOf:
            - $ref: '#/definitions/response.ApiResponse'
            - properties:
                data:
                  $ref: '#/definitions/common.UserInfo'
              type: object
        "400":
          description: 请求错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "500":
          description: 内部错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
      summary: 获取个人信息
      tags:
      - Common
    post:
      consumes:
      - application/json
      parameters:
      - description: Bearer 用户令牌
        in: header
        name: Authorization
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "400":
          description: 请求错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "500":
          description: 内部错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
      summary: 退出登录
      tags:
      - Common
  /v1/api/admin/role:
    post:
      consumes:
      - application/json
      description: 创建角色
      parameters:
      - description: Bearer 用户令牌
        in: header
        name: Authorization
        required: true
        type: string
      - description: 请求body
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/admin_role.CreateAdminRoleRequest'
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "400":
          description: 请求错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "500":
          description: 内部错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
      summary: 新增角色
      tags:
      - Role 角色管理
  /v1/api/admin/role/{roleID}:
    delete:
      consumes:
      - application/json
      description: 删除角色
      parameters:
      - description: Bearer 用户令牌
        in: header
        name: Authorization
        required: true
        type: string
      - description: 角色ID
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "400":
          description: 请求错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "500":
          description: 内部错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
      summary: 删除
      tags:
      - Role 角色管理
    get:
      consumes:
      - application/json
      description: 获取角色详情
      parameters:
      - description: Bearer 用户令牌
        in: header
        name: Authorization
        required: true
        type: string
      - description: 角色ID
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            allOf:
            - $ref: '#/definitions/response.ApiResponse'
            - properties:
                data:
                  $ref: '#/definitions/admin.RoleItem'
              type: object
        "400":
          description: 请求错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "500":
          description: 内部错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
      summary: 详情
      tags:
      - Role 角色管理
    put:
      consumes:
      - application/json
      description: 更新角色内容
      parameters:
      - description: Bearer 用户令牌
        in: header
        name: Authorization
        required: true
        type: string
      - description: 角色ID
        in: path
        name: id
        required: true
        type: integer
      - description: 请求body
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/admin_role.UpdateRequest'
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "400":
          description: 请求错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "500":
          description: 内部错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
      summary: 更新角色
      tags:
      - Role 角色管理
  /v1/api/admin/role/{roleID}/toggle:
    put:
      consumes:
      - application/json
      parameters:
      - description: Bearer 用户令牌
        in: header
        name: Authorization
        required: true
        type: string
      - description: 请求body
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/admin_role.ToggleRequest'
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "400":
          description: 请求错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "500":
          description: 内部错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
      summary: 启用/禁用
      tags:
      - Role 角色管理
  /v1/api/admin/role/labels:
    get:
      consumes:
      - application/json
      description: 获取所有已启用角色列表
      parameters:
      - description: Bearer 用户令牌
        in: header
        name: Authorization
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            allOf:
            - $ref: '#/definitions/response.ApiResponse'
            - properties:
                data:
                  $ref: '#/definitions/admin_role.EnabledRoles'
              type: object
        "400":
          description: 请求错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "500":
          description: 内部错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
      summary: 已启用角色列表
      tags:
      - Role 角色管理
  /v1/api/admin/roles:
    get:
      consumes:
      - application/json
      description: 获取角色列表
      parameters:
      - description: Bearer 用户令牌
        in: header
        name: Authorization
        required: true
        type: string
      - description: 页码
        in: query
        name: page
        required: true
        type: integer
      - description: 每页数量
        in: query
        name: page_size
        required: true
        type: integer
      - description: 关键字
        in: query
        name: keyword
        type: string
      - description: 状态
        enum:
        - enabled
        - disabled
        in: query
        name: status
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            allOf:
            - $ref: '#/definitions/response.ApiResponse'
            - properties:
                data:
                  $ref: '#/definitions/admin_role.ListAdminRolesResponse'
              type: object
        "400":
          description: 请求错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "500":
          description: 内部错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
      summary: 角色列表
      tags:
      - Role 角色管理
  /v1/api/admin/user:
    post:
      consumes:
      - application/json
      description: 创建用户
      parameters:
      - description: Bearer 用户令牌
        in: header
        name: Authorization
        required: true
        type: string
      - description: 请求body
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/admin_user.UserRequest'
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "400":
          description: 请求错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "500":
          description: 内部错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
      summary: 新增用户
      tags:
      - User 用户管理
  /v1/api/admin/user/{id}:
    get:
      consumes:
      - application/json
      description: 获取用户详情
      parameters:
      - description: Bearer 用户令牌
        in: header
        name: Authorization
        required: true
        type: string
      - description: 角色ID
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            allOf:
            - $ref: '#/definitions/response.ApiResponse'
            - properties:
                data:
                  $ref: '#/definitions/authorization_client.GetAdminUser'
              type: object
        "400":
          description: 请求错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "500":
          description: 内部错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
      summary: 详情
      tags:
      - User 用户管理
  /v1/api/admin/user/{userID}:
    delete:
      consumes:
      - application/json
      description: 删除管理员
      parameters:
      - description: Bearer 用户令牌
        in: header
        name: Authorization
        required: true
        type: string
      - description: 用户ID
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "400":
          description: 请求错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "500":
          description: 内部错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
      summary: 删除
      tags:
      - User 用户管理
    put:
      consumes:
      - application/json
      description: 更新用户内容
      parameters:
      - description: Bearer 用户令牌
        in: header
        name: Authorization
        required: true
        type: string
      - description: 角色ID
        in: path
        name: id
        required: true
        type: integer
      - description: 请求body
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/admin_user.UpdateRequest'
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "400":
          description: 请求错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "500":
          description: 内部错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
      summary: 修改个人信息
      tags:
      - User 用户管理
  /v1/api/admin/user/{userID}/toggle:
    put:
      consumes:
      - application/json
      parameters:
      - description: Bearer 用户令牌
        in: header
        name: Authorization
        required: true
        type: string
      - description: 请求body
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/admin_user.ToggleRequest'
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "400":
          description: 请求错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "500":
          description: 内部错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
      summary: 启用/禁用
      tags:
      - User 用户管理
  /v1/api/admin/user/labels:
    get:
      consumes:
      - application/json
      description: 获取所有已启用 用户列表
      parameters:
      - description: Bearer 用户令牌
        in: header
        name: Authorization
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            allOf:
            - $ref: '#/definitions/response.ApiResponse'
            - properties:
                data:
                  items:
                    $ref: '#/definitions/admin_user.EnabledUserItem'
                  type: array
              type: object
        "400":
          description: 请求错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "500":
          description: 内部错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
      summary: 已启用 用户列表
      tags:
      - User 用户管理
  /v1/api/admin/users:
    get:
      consumes:
      - application/json
      description: 获取用户列表
      parameters:
      - description: Bearer 用户令牌
        in: header
        name: Authorization
        required: true
        type: string
      - description: 页码
        in: query
        name: page
        required: true
        type: integer
      - description: 每页数量
        in: query
        name: page_size
        required: true
        type: integer
      - description: 关键字
        in: query
        name: keyword
        type: string
      - description: 状态
        enum:
        - enabled
        - disabled
        in: query
        name: status
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            allOf:
            - $ref: '#/definitions/response.ApiResponse'
            - properties:
                data:
                  $ref: '#/definitions/admin_user.ListAdminUserResponse'
              type: object
        "400":
          description: 请求错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
        "500":
          description: 内部错误
          schema:
            $ref: '#/definitions/response.ApiResponse'
      summary: 用户列表
      tags:
      - User 用户管理
securityDefinitions:
  BasicAuth:
    type: basic
swagger: "2.0"