zhangqian
2023-09-12 ccc4c924d81c3f8201e7a6c783a9a7148b21670d
docs/swagger.yaml
@@ -1,4 +1,58 @@
definitions:
  constvar.BaseJobType:
    enum:
    - 1
    - 2
    - 3
    type: integer
    x-enum-comments:
      BaseJobTypeIncoming: 收货
      BaseJobTypeInternal: 内部调拨
      BaseJobTypeOutgoing: 交货
    x-enum-varnames:
    - BaseJobTypeIncoming
    - BaseJobTypeOutgoing
    - BaseJobTypeInternal
  constvar.ReservationMethod:
    enum:
    - 1
    - 2
    - 3
    type: integer
    x-enum-comments:
      ReservationMethodAtConfirm: 在确认时
      ReservationMethodByDate: 在预定日期之前
      ReservationMethodManual: 手动
    x-enum-varnames:
    - ReservationMethodAtConfirm
    - ReservationMethodManual
    - ReservationMethodByDate
  constvar.WhetherType:
    enum:
    - 1
    - 2
    - 3
    type: integer
    x-enum-comments:
      ReservationNever: 从不
      WhetherTypeAlways: 总是
      WhetherTypeAsk: 询问
    x-enum-varnames:
    - WhetherTypeAsk
    - WhetherTypeAlways
    - ReservationNever
  models.Company:
    properties:
      createTime:
        type: string
      id:
        type: integer
      name:
        description: 公司名称
        type: string
      updateTime:
        type: string
    type: object
  models.Department:
    properties:
      children:
@@ -26,6 +80,88 @@
        description: 排序
        type: integer
    type: object
  models.JobType:
    properties:
      ReservationDaysBeforePriority:
        description: 在优先级的前几天
        type: integer
      baseJobType:
        allOf:
        - $ref: '#/definitions/constvar.BaseJobType'
        description: 基础作业类型
      company:
        allOf:
        - $ref: '#/definitions/models.Company'
        description: 公司
      companyId:
        description: 公司id
        type: integer
      createBackorder:
        allOf:
        - $ref: '#/definitions/constvar.WhetherType'
        description: 创建欠单
      createTime:
        type: string
      defaultLocationDest:
        allOf:
        - $ref: '#/definitions/models.Location'
        description: 默认目标位置
      defaultLocationDestId:
        description: 默认目标位置id
        type: integer
      defaultLocationSrc:
        allOf:
        - $ref: '#/definitions/models.Location'
        description: 默认源位置
      defaultLocationSrcId:
        description: 默认源位置id
        type: integer
      id:
        type: integer
      name:
        description: 仓库名称
        type: string
      printLabel:
        description: 是否打印标签
        type: boolean
      reservationDaysBefore:
        description: 收货前几天
        type: integer
      reservationMethod:
        allOf:
        - $ref: '#/definitions/constvar.ReservationMethod'
        description: 保留方式
      returnJobType:
        description: 退货类型名称
        type: string
      returnJobTypeID:
        description: 退货类型ID
        type: integer
      showOperations:
        description: 显示作业详情
        type: boolean
      updateTime:
        type: string
      warehouse:
        allOf:
        - $ref: '#/definitions/models.Warehouse'
        description: 仓库
      warehouseId:
        description: 仓库id
        type: integer
    type: object
  models.Location:
    properties:
      createTime:
        type: string
      id:
        type: integer
      name:
        description: 位置名称
        type: string
      updateTime:
        type: string
    type: object
  models.Warehouse:
    properties:
      active:
@@ -39,8 +175,14 @@
        maxLength: 5
        minLength: 1
        type: string
      company:
        $ref: '#/definitions/models.Company'
      companyId:
        type: integer
      createTime:
        type: string
      id:
        type: integer
      name:
        description: 仓库名称
        type: string
@@ -62,6 +204,12 @@
    required:
    - code
    type: object
  request.AddCompany:
    properties:
      name:
        description: 公司名称
        type: string
    type: object
  request.AddDepartment:
    properties:
      name:
@@ -76,6 +224,53 @@
      remark:
        description: 备注
        type: string
    type: object
  request.AddJobType:
    properties:
      ReservationDaysBeforePriority:
        description: 在优先级的前几天
        type: integer
      baseJobType:
        allOf:
        - $ref: '#/definitions/constvar.BaseJobType'
        description: 基础作业类型
      companyId:
        description: 公司id
        type: integer
      createBackorder:
        allOf:
        - $ref: '#/definitions/constvar.WhetherType'
        description: 创建欠单
      defaultLocationDestId:
        description: 默认目标位置id
        type: integer
      defaultLocationSrcId:
        description: 默认源位置id
        type: integer
      id:
        type: integer
      name:
        description: 仓库名称
        type: string
      printLabel:
        description: 是否打印标签
        type: boolean
      reservationDaysBefore:
        description: 收货前几天
        type: integer
      reservationMethod:
        allOf:
        - $ref: '#/definitions/constvar.ReservationMethod'
        description: 保留方式
      returnJobTypeID:
        description: 退货类型ID
        type: integer
      showOperations:
        description: 显示作业详情
        type: boolean
      warehouseId:
        description: 仓库id
        type: integer
    type: object
  request.AddWarehouse:
    properties:
@@ -104,6 +299,14 @@
    required:
    - code
    type: object
  request.UpdateCompany:
    properties:
      id:
        type: integer
      name:
        description: 公司名称
        type: string
    type: object
  request.UpdateDepartment:
    properties:
      id:
@@ -120,6 +323,53 @@
      remark:
        description: 备注
        type: string
    type: object
  request.UpdateJobType:
    properties:
      ReservationDaysBeforePriority:
        description: 在优先级的前几天
        type: integer
      baseJobType:
        allOf:
        - $ref: '#/definitions/constvar.BaseJobType'
        description: 基础作业类型
      companyId:
        description: 公司id
        type: integer
      createBackorder:
        allOf:
        - $ref: '#/definitions/constvar.WhetherType'
        description: 创建欠单
      defaultLocationDestId:
        description: 默认目标位置id
        type: integer
      defaultLocationSrcId:
        description: 默认源位置id
        type: integer
      id:
        type: integer
      name:
        description: 仓库名称
        type: string
      printLabel:
        description: 是否打印标签
        type: boolean
      reservationDaysBefore:
        description: 收货前几天
        type: integer
      reservationMethod:
        allOf:
        - $ref: '#/definitions/constvar.ReservationMethod'
        description: 保留方式
      returnJobTypeID:
        description: 退货类型ID
        type: integer
      showOperations:
        description: 显示作业详情
        type: boolean
      warehouseId:
        description: 仓库id
        type: integer
    type: object
  request.UpdateWarehouse:
    properties:
@@ -258,6 +508,186 @@
      summary: 编辑部门信息
      tags:
      - 部门信息
  /api-wms/v1/company/company:
    get:
      parameters:
      - in: query
        name: keyword
        type: string
      - description: 页码
        in: query
        name: page
        type: integer
      - description: 每页大小
        in: query
        name: pageSize
        type: integer
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            allOf:
            - $ref: '#/definitions/util.ResponseList'
            - properties:
                data:
                  items:
                    $ref: '#/definitions/models.Company'
                  type: array
              type: object
      summary: 查询公司列表
      tags:
      - 公司
    post:
      parameters:
      - description: 公司信息
        in: body
        name: object
        required: true
        schema:
          $ref: '#/definitions/request.AddCompany'
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/util.Response'
      summary: 添加公司
      tags:
      - 公司
  /api-wms/v1/company/company/{id}:
    delete:
      parameters:
      - description: 公司id
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/util.Response'
      summary: 删除公司
      tags:
      - 公司
    put:
      parameters:
      - description: 公司信息
        in: body
        name: object
        required: true
        schema:
          $ref: '#/definitions/request.UpdateCompany'
      - description: 公司id
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/util.Response'
      summary: 编辑公司
      tags:
      - 公司
  /api-wms/v1/warehouse/jobType:
    get:
      parameters:
      - in: query
        name: keyword
        type: string
      - description: 页码
        in: query
        name: page
        type: integer
      - description: 每页大小
        in: query
        name: pageSize
        type: integer
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            allOf:
            - $ref: '#/definitions/util.ResponseList'
            - properties:
                data:
                  items:
                    $ref: '#/definitions/models.JobType'
                  type: array
              type: object
      summary: 查询作业类型列表
      tags:
      - 作业类型
    post:
      parameters:
      - description: 作业类型信息
        in: body
        name: object
        required: true
        schema:
          $ref: '#/definitions/request.AddJobType'
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/util.Response'
      summary: 添加作业类型
      tags:
      - 作业类型
  /api-wms/v1/warehouse/jobType/{id}:
    delete:
      parameters:
      - description: 作业类型id
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/util.Response'
      summary: 删除作业类型
      tags:
      - 作业类型
    put:
      parameters:
      - description: 作业类型信息
        in: body
        name: object
        required: true
        schema:
          $ref: '#/definitions/request.UpdateJobType'
      - description: 作业类型id
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/util.Response'
      summary: 编辑作业类型
      tags:
      - 作业类型
  /api-wms/v1/warehouse/warehouse:
    get:
      parameters: