Update user_id/user_name/user_token header alias

- Change user_id alias to User-Id
- Update user_name alias to User-Name
- Update user_token alias to User-Token
- Modify error messages for consistency

Author: wanghh2000

data_server/api/endpoints/algo_templates.py

@@ -33,7 +33,7 @@ class AlgoTemplateListResponse(BaseModel):
 
 @router.get("", response_model=dict, summary="获取算法模板列表")
 async def get_algo_templates(
-    user_id: str = Header(..., alias="user_id", description="用户ID"),
+    user_id: str = Header(..., alias="User-Id", description="用户ID"),
     page: int = Query(1, ge=1, description="页码"),
     page_size: int = Query(10, ge=1, le=100000000, description="每页数量"),
     buildin: bool = Query(None,description="是否为内置模版过滤"),
@@ -42,7 +42,7 @@ async def get_algo_templates(
 
     try:
         if not user_id:
-            return response_fail(msg="请求头中缺少用户信息 (user_id)")
+            return response_fail(msg="请求头中缺少用户信息 (User-Id)")
 
         templates, total = get_templates_by_query(
             db, user_id, page, page_size, buildin
@@ -72,14 +72,14 @@ async def get_algo_templates(
 
 @router.get("/{template_id}", response_model=dict, summary="根据模板id获取单个算法模板详情")
 async def get_algo_template_by_id(
-    user_id: str = Header(..., alias="user_id", description="用户ID"),
+    user_id: str = Header(..., alias="User-Id", description="用户ID"),
     template_id: int = Path(..., description="模板ID"),
     db: Session = Depends(get_sync_session)
 ):
 
     try:
         if not user_id:
-            return response_fail(msg="请求头中缺少用户信息 (user_id)")
+            return response_fail(msg="请求头中缺少用户信息 (User-Id)")
 
 
         template = get_template_by_id(db, template_id, user_id)
@@ -104,13 +104,13 @@ async def get_algo_template_by_id(
 @router.post("", response_model=dict, summary="创建新的算法模板")
 async def create_algo_template(
     template_data: AlgoTemplateCreate,
-    user_id: str = Header(..., alias="user_id", description="用户ID"),
+    user_id: str = Header(..., alias="User-Id", description="用户ID"),
     db: Session = Depends(get_sync_session)
 ):
 
     try:
         if not user_id:
-            return response_fail(msg="请求头中缺少用户信息 (user_id)")
+            return response_fail(msg="请求头中缺少用户信息 (User_Id)")
 
 
         template_dict = template_data.model_dump(exclude_none=True)
@@ -140,15 +140,15 @@ async def create_algo_template(
 
 @router.put("/{template_id}", response_model=dict, summary="更新算法模板")
 async def update_algo_template(
-    user_id: str = Header(..., alias="user_id", description="用户ID"),
+    user_id: str = Header(..., alias="User-Id", description="用户ID"),
     template_id: int = Path(..., description="模板ID"),
     template_data: AlgoTemplateUpdate = None,
     db: Session = Depends(get_sync_session)
 ):
 
     try:
         if not user_id:
-            return response_fail(msg="请求头中缺少用户信息 (user_id)")
+            return response_fail(msg="请求头中缺少用户信息 (User-Id)")
 
 
         current_template = get_template_by_id(db, template_id, user_id)
@@ -186,14 +186,14 @@ async def update_algo_template(
 
 @router.delete("/{template_id}", response_model=dict, summary="删除算法模板")
 async def delete_algo_template(
-    user_id: str = Header(..., alias="user_id", description="用户ID"),
+    user_id: str = Header(..., alias="User-Id", description="用户ID"),
     template_id: int = Path(..., description="模板ID"),
     db: Session = Depends(get_sync_session)
 ):
 
     try:
         if not user_id:
-            return response_fail(msg="请求头中缺少用户信息 (user_id)")
+            return response_fail(msg="请求头中缺少用户信息 (User-Id)")
 
 
         success = delete_template_by_id(db, template_id, user_id)
@@ -225,14 +225,14 @@ async def get_algo_template_type():
 
 @router.get("/get/ByName", response_model=dict, summary="根据模版名称获取算法模板列表")
 async def get_algo_template_by_name(
-    user_id: str = Header(..., alias="user_id", description="用户ID"),
+    user_id: str = Header(..., alias="User-Id", description="用户ID"),
     template_name: str = Query(..., description="模板名称"),
     db: Session = Depends(get_sync_session)
 ):
 
     try:
         if not user_id:
-            return response_fail(msg="请求头中缺少用户信息 (user_id)")
+            return response_fail(msg="请求头中缺少用户信息 (User_Id)")
 
 
         template = find_repeat_name(db, template_name, user_id)

data_server/api/endpoints/datasource.py

@@ -84,9 +84,9 @@ async def get_task_statistics(db: Session = Depends(get_sync_session)):
 
 @router.post("/datasource/create", response_model=dict)
 async def create_datasource(datasource: DataSourceCreate, db: Session = Depends(get_sync_session),
-                            user_name: Annotated[str | None, Header(alias="user_name")] = None,
-                            user_id: Annotated[str | None, Header(alias="user_id")] = None,
-                            user_token: Annotated[str | None, Header(alias="user_token")] = None
+                            user_name: Annotated[str | None, Header(alias="User-Name")] = None,
+                            user_id: Annotated[str | None, Header(alias="User-Id")] = None,
+                            user_token: Annotated[str | None, Header(alias="User-Token")] = None
                             ):
 
     try:
@@ -114,7 +114,7 @@ async def create_datasource(datasource: DataSourceCreate, db: Session = Depends(
 
 @router.get("/datasource/list", response_model=dict)
 async def datasource_list(user_id: Annotated[str | None,
-Header(alias="user_id")] = None,
+Header(alias="User-Id")] = None,
                           isadmin: Annotated[bool | None,
                           Header(alias="isadmin")] = None,
                           page: int = 0, pageSize: int = 20,
@@ -183,8 +183,8 @@ async def delete_datasource(datasource_id: int, db: Session = Depends(get_sync_s
 async def datasource_run_task(datasource_id: int,
                               data: dict = Body(...),
                               db: Session = Depends(get_sync_session),
-                              user_name: Annotated[str | None, Header(alias="user_name")] = None,
-                              user_token: Annotated[str | None, Header(alias="user_token")] = None
+                              user_name: Annotated[str | None, Header(alias="User-Name")] = None,
+                              user_token: Annotated[str | None, Header(alias="User-Token")] = None
                               ):
 
 
@@ -313,8 +313,8 @@ async def get_collection_task_details(task_id: int,
 
 @router.post("/tasks/execute/{task_id}", response_model=dict)
 async def run_task(task_id: int, db: Session = Depends(get_sync_session),
-                   user_name: Annotated[str | None, Header(alias="user_name")] = None,
-                   user_token: Annotated[str | None, Header(alias="user_token")] = None
+                   user_name: Annotated[str | None, Header(alias="User-Name")] = None,
+                   user_token: Annotated[str | None, Header(alias="User-Token")] = None
                    ):
 
     try:

data_server/api/endpoints/formatify.py

@@ -66,9 +66,9 @@ async def get_task_statistics(db: Session = Depends(get_sync_session)):
 
 @router.post("/formatify/create", response_model=dict)
 async def create_formatify_task_api(dataFormatTask: DataFormatTaskRequest,
-                                    user_id: Annotated[str | None, Header(alias="user_id")] = None,
-                                    user_name: Annotated[str | None, Header(alias="user_name")] = None,
-                                    user_token: Annotated[str | None, Header(alias="user_token")] = None
+                                    user_id: Annotated[str | None, Header(alias="User-Id")] = None,
+                                    user_name: Annotated[str | None, Header(alias="User-Name")] = None,
+                                    user_token: Annotated[str | None, Header(alias="User-Token")] = None
                                     ):
     """
     Create a format conversion task
@@ -91,7 +91,7 @@ async def create_formatify_task_api(dataFormatTask: DataFormatTaskRequest,
 
 
 @router.get("/formatify/list", response_model=dict)
-async def formatify_list(user_id: Annotated[str | None, Header(alias="user_id")] = None,
+async def formatify_list(user_id: Annotated[str | None, Header(alias="User-Id")] = None,
                          isadmin: Annotated[bool | None, Header(alias="isadmin")] = None,
                          name: str = None,
                          page: int = 1, pageSize: int = 20,

data_server/api/endpoints/job.py

@@ -64,7 +64,7 @@ async def job_list(
         query: Optional[str] = None,
         page: int = 1,
         page_size: int = 20,
-        user_id: Annotated[str | None, Header(alias="user_id")] = None,
+        user_id: Annotated[str | None, Header(alias="User-Id")] = None,
         isadmin: Annotated[bool | None, Header(alias="isadmin")] = None,
         session: Session = Depends(get_sync_session)):
     try:
@@ -92,7 +92,7 @@ async def job_list(
 @router.get("/{id}", description="Get the details of the job by id")
 async def read_job(id: int,
                    user_id: Annotated[str | None,
-                                      Header(alias="user_id")] = None,
+                                      Header(alias="User-Id")] = None,
                    isadmin: Annotated[bool | None,
                                       Header(alias="isadmin")] = None,
                    session: Session = Depends(get_sync_session)):
@@ -117,7 +117,7 @@ async def read_job(id: int,
 @router.get("/log/{id}", description="Get the log of the job by id")
 async def read_log(id: int,
                    user_id: Annotated[str | None,
-                                      Header(alias="user_id")] = None,
+                                      Header(alias="User-Id")] = None,
                    isadmin: Annotated[bool | None,
                                       Header(alias="isadmin")] = None,
                    session: Session = Depends(get_sync_session)):
@@ -141,7 +141,7 @@ async def read_log(id: int,
 
 @router.get("/pipline_job_log/{id}", response_model=dict,description="Get the log of the job by id")
 async def read_pipline_job_log(id: int,
-                               user_id: Annotated[str | None,Header(alias="user_id")] = None,
+                               user_id: Annotated[str | None,Header(alias="User-Id")] = None,
                                page: int = 1,
                                page_size: int = 20,
                                level: str = "",
@@ -162,7 +162,7 @@ async def read_pipline_job_log(id: int,
 @router.post("/pipline_job_operators_status", response_model=dict,description="Get the operators_status of the job by id")
 async def read_pipline_job_operators_status(
                                operators: OperatorIdentifier,
-                               user_id: Annotated[str | None,Header(alias="user_id")] = None,
+                               user_id: Annotated[str | None,Header(alias="User-Id")] = None,
                                session: Session = Depends(get_sync_session)):
     try:
         job = get_job_data(job_id=operators.job_id, user_id=user_id, session=session)
@@ -175,7 +175,7 @@ async def read_pipline_job_operators_status(
 
 @router.get("/get_pipline_job_operators_status/{job_id}", response_model=dict,description="Get the operators_status of the job by id")
 async def get_pipline_job_operators_status_api(job_id: int,
-                               user_id: Annotated[str | None,Header(alias="user_id")] = None,
+                               user_id: Annotated[str | None,Header(alias="User-Id")] = None,
                                session: Session = Depends(get_sync_session)):
     try:
         job = get_job_data(job_id=job_id, user_id=user_id, session=session)
@@ -192,7 +192,7 @@ async def get_pipline_job_operators_status_api(job_id: int,
 @router.get("/resource/{id}", response_model=dict,description="Get the process resource of the job by id")
 async def read_task_resource_info(id: int,
                     user_id: Annotated[str | None,
-                    Header(alias="user_id")] = None,
+                    Header(alias="User-Id")] = None,
                     session: Session = Depends(get_sync_session)):
     try:
         job = get_job_data(job_id=id, user_id=user_id,session=session)
@@ -221,9 +221,9 @@ def create_job(
     # config:  Union[Tool,Recipe],
     # config: Union[Tool],
 
-    user_id: Annotated[str | None, Header(alias="user_id")] = None,
-    user_name: Annotated[str | None, Header(alias="user_name")] = None,
-    user_token: Annotated[str | None, Header(alias="user_token")] = None
+    user_id: Annotated[str | None, Header(alias="User-Id")] = None,
+    user_name: Annotated[str | None, Header(alias="User-Name")] = None,
+    user_token: Annotated[str | None, Header(alias="User-Token")] = None
 ):
     # print(user_id)
     # print(user_name)
@@ -248,9 +248,9 @@ def create_job(
 @router.post("/pipeline", response_model=dict,description="Create the dataflow job")
 def create_pipline_job(
     config:  Union[Recipe, Tool],
-    user_id: Annotated[str | None, Header(alias="user_id")] = None,
-    user_name: Annotated[str | None, Header(alias="user_name")] = None,
-    user_token: Annotated[str | None, Header(alias="user_token")] = None
+    user_id: Annotated[str | None, Header(alias="User-Id")] = None,
+    user_name: Annotated[str | None, Header(alias="User-Name")] = None,
+    user_token: Annotated[str | None, Header(alias="User-Token")] = None
 ):
     try:
         if config.job_source == "tool":
@@ -267,7 +267,7 @@ def create_pipline_job(
 
 @router.post("/stop_pipline_job", response_model=dict, description="stop the dataflow job")
 def stop_pipline_job(job_id: int,
-                     user_id: Annotated[str | None, Header(alias="user_id")] = None,
+                     user_id: Annotated[str | None, Header(alias="User-Id")] = None,
                      session: Session = Depends(get_sync_session)):
     try:
         job = get_job_data(job_id=job_id, user_id=user_id, session=session)
@@ -294,9 +294,9 @@ def stop_pipline_job(job_id: int,
 
 @router.post("/job/execute/{job_id}", response_model=dict)
 async def run_pipline_job(job_id: int,
-                    user_id: Annotated[str | None, Header(alias="user_id")] = None,
-                    user_name: Annotated[str | None, Header(alias="user_name")] = None,
-                    user_token: Annotated[str | None, Header(alias="user_token")] = None,
+                    user_id: Annotated[str | None, Header(alias="User-Id")] = None,
+                    user_name: Annotated[str | None, Header(alias="User-Name")] = None,
+                    user_token: Annotated[str | None, Header(alias="User-Token")] = None,
                     execute_time: str | None = None,
                     session: Session = Depends(get_sync_session)
                    ):
@@ -319,7 +319,7 @@ async def run_pipline_job(job_id: int,
 def delete_job(
     id: int,
     user_id: Annotated[str | None,
-                       Header(alias="user_id")] = None,
+                       Header(alias="User-Id")] = None,
     isadmin: Annotated[bool | None,
                        Header(alias="isadmin")] = None,
     session: Session = Depends(get_sync_session)

data_server/api/endpoints/jump_to_studio.py

@@ -15,8 +15,8 @@
 @router.post("/jump-to-studio", tags=["studio"])
 async def jump_to_studio(
     authorization: Optional[str] = Header(None, alias="authorization"),
-    user_token: Optional[str] = Header(None, alias="user_token"),
-    user_name: Optional[str] = Header(None, alias="user_name"),
+    user_token: Optional[str] = Header(None, alias="User-Token"),
+    user_name: Optional[str] = Header(None, alias="User-Name"),
 ):
     """Jump to studio with credentials from headers."""
 

data_server/api/endpoints/template.py

@@ -11,7 +11,7 @@
 
 @router.get("", response_model_exclude_none=True)
 async def templates(
-    user_id: Annotated[str | None, Header(alias="user_id")] = None, 
+    user_id: Annotated[str | None, Header(alias="User-Id")] = None, 
     isadmin: Annotated[bool | None, Header(alias="isadmin")] = None
 ) -> list[Recipe]:
     try:
@@ -25,7 +25,7 @@ async def templates(
 @router.post("")
 async def create_template(
     template: Recipe, 
-    user_id: Annotated[str | None, Header(alias="user_id")] = None
+    user_id: Annotated[str | None, Header(alias="User-Id")] = None
 ):
     try:
         """
@@ -57,7 +57,7 @@ async def create_template(
 @router.delete("/{template_id}")
 async def remove_template(
     template_id: str, 
-    user_id: Annotated[str | None, Header(alias="user_id")] = None, 
+    user_id: Annotated[str | None, Header(alias="User-Id")] = None, 
     isadmin: Annotated[bool | None, Header(alias="isadmin")] = None
 ):
     try:

data_server/api/endpoints/tool.py

@@ -8,7 +8,7 @@
 
 @router.get("")
 async def tools(
-    user_id: Annotated[str | None, Header(alias="user_id")] = None, 
+    user_id: Annotated[str | None, Header(alias="User-Id")] = None, 
     isadmin: Annotated[bool | None, Header(alias="isadmin")] = None
 ) -> dict[str, Tool]:
     try: