feat: jsdoc微调

src/api/huiShangyp/tacticalApi.js

@@ -85,252 +85,25 @@ export const endJudgment = (id) => {
     method: "post"
   })
 }
+
 /**
  * 新增研判报告
- * 研判报告管理
+ * @param {Object} data 研判报告数据
- * 例子： {
+ * @param {string} data.bgmc - 报告名称
-    "bgmc": "string",
+ * @param {string} data.bgnr - 报告内容
-    "bgnr": "string",
+ * @param {string} data.bz - 备注
-    "bz": "string",
+ * @param {string} data.cjrsfzh - 创建人身份证号
-    "cjrsfzh": "string",
+ * @param {string} data.cjrxm - 创建人姓名
-    "cjrxm": "string",
+ * @param {string} data.id - ID
-    "id": "string",
+ * @param {string} data.scsj - 生成时间
-    "scsj": "2019-08-24T14:15:22.123Z",
+ * @param {string} data.ssbm - 所属部门
-    "ssbm": "string",
+ * @param {string} data.ssbmdm - 所属部门代码
-    "ssbmdm": "string",
+ * @param {string} data.sssgaj - 所属市公安局
-    "sssgaj": "string",
+ * @param {string} data.sssgajdm - 所属市公安局代码
-    "sssgajdm": "string",
+ * @param {string} data.ssxgaj - 所属县公安局
-    "ssxgaj": "string",
+ * @param {string} data.ssxgajdm - 所属县公安局代码
-    "ssxgajdm": "string",
+ * @param {string} data.ypid - 研判来源ID(数据整理ID)
-    "xtCjbmdm": "string",
+ * @param {string} data.ypmc - 研判名称
-    "xtCjbmmc": "string",
-    "xtCjip": "string",
-    "xtCjr": "string",
-    "xtCjrId": "string",
-    "xtCjsj": {
-        "date": 0,
-        "day": 0,
-        "hours": 0,
-        "minutes": 0,
-        "month": 0,
-        "nanos": 0,
-        "seconds": 0,
-        "time": 0,
-        "timezoneOffset": 0,
-        "year": 0
-    },
-    "xtScbz": "string",
-    "xtSjly": "string",
-    "xtSjzt": "string",
-    "xtZhgxbm": "string",
-    "xtZhgxbmdm": "string",
-    "xtZhgxip": "string",
-    "xtZhgxr": "string",
-    "xtZhgxrid": "string",
-    "xtZhgxsj": {
-        "date": 0,
-        "day": 0,
-        "hours": 0,
-        "minutes": 0,
-        "month": 0,
-        "nanos": 0,
-        "seconds": 0,
-        "time": 0,
-        "timezoneOffset": 0,
-        "year": 0
-    },
-    "ypid": "string",
-    "ypmc": "string"
-}
-    内容：
- *
-bgmc
-string
-报告名称
-可选
-bgnr
-string
-报告内容
-可选
-bz
-string
-备注
-可选
-cjrsfzh
-string
-创建人身份证号
-可选
-cjrxm
-string
-创建人姓名
-可选
-id
-string
-ID
-可选
-scsj
-string <date-time>
-生成时间
-可选
-ssbm
-string
-所属部门
-可选
-ssbmdm
-string
-所属部门代码
-可选
-sssgaj
-string
-所属市公安局
-可选
-sssgajdm
-string
-所属市公安局代码
-可选
-ssxgaj
-string
-所属县公安局
-可选
-ssxgajdm
-string
-所属县公安局代码
-可选
-xtCjbmdm
-string
-创建部门代码
-可选
-xtCjbmmc
-string
-创建部门名称
-可选
-xtCjip
-string
-创建IP
-可选
-xtCjr
-string
-创建人名称
-可选
-xtCjrId
-string
-创建人ID
-可选
-xtCjsj
-object
-(Timestamp)
-Timestamp
-可选
-date
-integer <int32>
-可选
-day
-integer <int32>
-可选
-hours
-integer <int32>
-可选
-minutes
-integer <int32>
-可选
-month
-integer <int32>
-可选
-nanos
-integer <int32>
-可选
-seconds
-integer <int32>
-可选
-time
-integer <int64>
-可选
-timezoneOffset
-integer <int32>
-可选
-year
-integer <int32>
-可选
-xtScbz
-string
-可选
-删除标识：0、未删除，1、已删除
-
-xtSjly
-string
-可选
-数据来源：1、PC，2、手机端 3、大数据-一张网
-
-xtSjzt
-string
-可选
-数据状态：0、注销，1、正常，-1、封存
-
-xtZhgxbm
-string
-最后更新部门名称
-可选
-xtZhgxbmdm
-string
-最后更新部门代码
-可选
-xtZhgxip
-string
-最后更新IP
-可选
-xtZhgxr
-string
-最后更新人名称
-可选
-xtZhgxrid
-string
-最后更新人ID
-可选
-xtZhgxsj
-object
-(Timestamp)
-Timestamp
-可选
-date
-integer <int32>
-可选
-day
-integer <int32>
-可选
-hours
-integer <int32>
-可选
-minutes
-integer <int32>
-可选
-month
-integer <int32>
-可选
-nanos
-integer <int32>
-可选
-seconds
-integer <int32>
-可选
-time
-integer <int64>
-可选
-timezoneOffset
-integer <int32>
-可选
-year
-integer <int32>
-可选
-ypid
-string
-可选
-研判来源ID(数据整理ID)
-
-ypmc
-string
-研判名称
-
-
  * @returns {Promise} 请求Promise对象
  */
 export const gsxtYpbgAddEntity = (data) => {
@@ -344,15 +117,15 @@ export const gsxtYpbgAddEntity = (data) => {
 /**
  * 自建研判报告
  * @param {Object} data 自建研判数据
- * @param {Array<Object>} [data.cyypList] 自建研判数据列表
+ * @param {Array<Object>} data.cyypList 自建研判数据列表
- * @param {string} [data.cyypList[].fj] - 附件
+ * @param {string} data.cyypList[].fj - 附件
- * @param {string} [data.cyypList[].id] - ID
+ * @param {string} data.cyypList[].id - ID
- * @param {string} [data.cyypList[].scyq] - 素材要求
+ * @param {string} data.cyypList[].scyq - 素材要求
- * @param {string} [data.cyypList[].sjzlid] - 研判数据整理ID
+ * @param {string} data.cyypList[].sjzlid - 研判数据整理ID
- * @param {string} [data.cyypList[].wcqk] - 完成情况（01 准备中、02 已完成）
+ * @param {string} data.cyypList[].wcqk - 完成情况（01 准备中、02 已完成）
- * @param {string} [data.cyypList[].wcsj] - 完成时间
+ * @param {string} data.cyypList[].wcsj - 完成时间
- * @param {string} [data.cyypList[].ypbmdm] - 研判部门代码
+ * @param {string} data.cyypList[].ypbmdm - 研判部门代码
- * @param {string} [data.cyypList[].ypbmmc] - 研判部门名称
+ * @param {string} data.cyypList[].ypbmmc - 研判部门名称
  * @param {Object} data.ypbgDto 研判报告DTO
  * @param {string} data.ypbgDto.bgmc 报告名称
  * @param {string} data.ypbgDto.bgnr 报告内容
@@ -373,11 +146,11 @@ export const selfBuildJudgment = (data) => {
 /**
  * 研判指令列表
  * @param {Object} params 查询参数
- * @param {number} [params.pageSize] 每页显示数量
+ * @param {number} params.pageSize 每页显示数量
- * @param {number} [params.pageCurrent] 页码
+ * @param {number} params.pageCurrent 页码
- * @param {string} [params.zlbt] 指令标题
+ * @param {string} params.zlbt 指令标题
- * @param {string} [params.zlnr] 指令内容
+ * @param {string} params.zlnr 指令内容
- * @param {string} [params.fqrxm] 发起人姓名
+ * @param {string} params.fqrxm 发起人姓名
  * @returns {Promise} 请求Promise对象
  */
 export const getJudgmentCommandList = (params) => {