Quellcode durchsuchen

一些接口注释

AnlaAnla vor 2 Wochen
Ursprung
Commit
6c188c15dc
2 geänderte Dateien mit 6 neuen und 6 gelöschten Zeilen
  1. 2 2
      app/api/formate_xy.py
  2. 4 4
      app/api/rating_report.py

+ 2 - 2
app/api/formate_xy.py

@@ -129,7 +129,7 @@ def get_card_details(
             cursor.close()
 
 
-@router.put("/update/json/{id}", status_code=200, summary="接收xy格式, 还原后重计算分数并保存")
+@router.put("/update/json/{id}", status_code=200, summary="接收xy格式, 还原后重计算分数并保存 [用户调用]")
 async def update_image_modified_json(
         id: int,
         new_json_data: dict = Body(..., description="前端传来的包含xy对象格式的JSON"),
@@ -248,7 +248,7 @@ async def update_image_modified_json(
 
 
 # 处理灰度如
-@router.put("/update/json_gray/{id}", status_code=200, summary="[灰度] 接收xy格式, 合并至Ring图重计算并保存")
+@router.put("/update/json_gray/{id}", status_code=200, summary="[灰度] 接收xy格式, 合并至Ring图重计算并保存 [用户调用]")
 async def update_gray_image_json(
         id: int,
         new_json_data: dict = Body(..., description="前端传来的灰度图编辑后的JSON(xy格式)"),

+ 4 - 4
app/api/rating_report.py

@@ -36,7 +36,7 @@ def _build_history_detail_response(row: dict, report_data: dict) -> dict:
     }
 
 
-@router.get("/generate", status_code=200, summary="生成评级报告数据")
+@router.get("/generate", status_code=200, summary="生成评级报告数据 [用户调用]")
 def generate_rating_report(
         cardNo: str,
         db_conn: PooledMySQLConnection = Depends(get_db_connection)
@@ -208,7 +208,7 @@ def generate_rating_report(
     return response_data
 
 
-@router.get("/history", status_code=200, summary="根据 cardNo 查询评级报告历史列表")
+@router.get("/history", status_code=200, summary="根据 cardNo 查询评级报告历史列表 [用户调用]")
 def get_rating_report_history_list(
         cardNo: str,
         skip: int = Query(0, ge=0),
@@ -265,7 +265,7 @@ def get_rating_report_history_list(
     }
 
 
-@router.get("/history/compare", status_code=200, summary="根据两个 rating_id 对比历史缺陷差异")
+@router.get("/history/compare", status_code=200, summary="根据两个 rating_id 对比历史缺陷差异 [用户调用]")
 def compare_rating_report_history(
         rating_id1: int = Query(..., description="第一个历史记录 ID"),
         rating_id2: int = Query(..., description="第二个历史记录 ID"),
@@ -317,7 +317,7 @@ def compare_rating_report_history(
     }
 
 
-@router.get("/history/{rating_id}", status_code=200, summary="根据 rating_id 查询单个评级报告历史")
+@router.get("/history/{rating_id}", status_code=200, summary="根据 rating_id 查询单个评级报告历史 [用户调用]")
 def get_rating_report_history_detail(
         rating_id: int,
         db_conn: PooledMySQLConnection = Depends(get_db_connection)