docs: 为已有的路由编写完整名称和文档

src/nyahome/router/chatroom_router.py

@@ -31,7 +31,7 @@ from .response_model import ReturnDto
 chatroom_router = APIRouter(tags=["Chatroom"], prefix="/chatroom")
 
 
-@chatroom_router.get("/{id_}/")
+@chatroom_router.get("/{id_}/", name="获取指定聊天室")
 async def get_chatroom(
     id_: int, user: Annotated[ModelUser, Depends(verify_token)], session: Annotated[Session, Depends(get_session)]
 ) -> ReturnDto:
@@ -54,7 +54,7 @@ async def get_chatroom(
         return ReturnDto(result=cr.model_dump())
 
 
-@chatroom_router.get("/")
+@chatroom_router.get("/", name="获取聊天室列表")
 async def get_all_chatroom(
     user: Annotated[ModelUser, Depends(verify_token)], session: Annotated[Session, Depends(get_session)]
 ) -> ReturnDto:
@@ -68,7 +68,7 @@ async def get_all_chatroom(
     return ReturnDto(result=[cr.model_dump(exclude={"content", "script"}) for cr in crs])
 
 
-@chatroom_router.post("/")
+@chatroom_router.post("/", name="创建聊天室")
 async def create_chatroom(
     chatroom: ChatroomPublic,
     user: Annotated[ModelUser, Depends(verify_token)],
@@ -96,7 +96,7 @@ async def create_chatroom(
     return ReturnDto(result=cr.model_dump())
 
 
-@chatroom_router.post("/{id_}/")
+@chatroom_router.post("/{id_}/", name="修改指定聊天室")
 async def edit_chatroom(
     id_: int,
     chatroom: ChatroomPublic,
@@ -131,13 +131,14 @@ async def edit_chatroom(
         cr.feature_image = chatroom.feature_image
     cr.script_template_id = chatroom.script_template_id
     cr.script_template_version = chatroom.script_template_version
+    cr.default_model_id = chatroom.default_model_id
     session.add(cr)
     session.commit()
     session.refresh(cr)
     return ReturnDto(result=cr.model_dump())
 
 
-@chatroom_router.post("/{id_}/script/")
+@chatroom_router.post("/{id_}/script/", name="修改聊天室脚本")
 async def update_chatroom_script(
     id_: int,
     script: ChatScript,
@@ -172,7 +173,7 @@ async def update_chatroom_script(
     return ReturnDto(result=script.model_dump())
 
 
-@chatroom_router.post("/{id_}/chat/")
+@chatroom_router.post("/{id_}/chat/", name="聊天室发起模型创作")
 async def post_chatroom_chat(
     id_: int,
     chat: ChatroomChat,
@@ -181,6 +182,7 @@ async def post_chatroom_chat(
 ) -> StreamingResponse:
     """
     在聊天室中发送新的用户消息，流式返回 AI 调用结果。
+    即：调用模型发起创作。
 
     Args:
         id_: （路径参数）聊天室 ID
@@ -203,7 +205,7 @@ async def post_chatroom_chat(
         raise e
 
 
-@chatroom_router.post("/{id_}/chat/accept/")
+@chatroom_router.post("/{id_}/chat/accept/", name="聊天室保存模型创作")
 async def accept_chatroom_chat(
     id_: int,
     accept: ChatroomChatAccept,
@@ -212,6 +214,7 @@ async def accept_chatroom_chat(
 ) -> ReturnDto:
     """
     此端点不负责调用 AI 生成输出，而是用于保存一对用户消息和 AI 输出到聊天室 content 的最后。
+    需要提供用户消息、AI 消息和创作模式。
 
     Raises:
         HTTPException: 404 表明未找到聊天室。
@@ -232,7 +235,7 @@ async def accept_chatroom_chat(
     return ReturnDto(result=cr.model_dump())
 
 
-@chatroom_router.post("/{id_}/chat/edit/")
+@chatroom_router.post("/{id_}/chat/edit/", name="聊天室编辑消息")
 async def edit_chatroom_chat(
     id_: int,
     edit: ChatroomChatEdit,
@@ -241,6 +244,7 @@ async def edit_chatroom_chat(
 ) -> ReturnDto:
     """
     此端点不负责调用 AI 生成输出，而是用于修改一条已经保存在聊天记录中的消息。
+    需要提供消息类型（用户/AI）、旧消息和新消息，以便进行替换。
 
     Raises:
         HTTPException: 404 表明未找到聊天室，400 表明聊天记录匹配失败，未更新。
@@ -264,7 +268,7 @@ async def edit_chatroom_chat(
         raise HTTPException(status_code=400, detail=str(e)) from e
 
 
-@chatroom_router.post("/{id_}/chat/delete/")
+@chatroom_router.post("/{id_}/chat/delete/", name="聊天室删除消息")
 async def delete_chatroom_chat(
     id_: int,
     delete: ChatroomChatDelete,
@@ -273,6 +277,7 @@ async def delete_chatroom_chat(
 ) -> ReturnDto:
     """
     此端点不负责调用 AI 生成输出，而是用于删除一条已经保存在聊天记录中的消息。关联的 user 或 aii 消息会一并删除。
+    需要提供消息和消息类型（用户/AI）。用户消息和 AI 消息是一对一成对的，所以总是会删除关联的一对（两条）消息。
 
     Raises:
         HTTPException: 404 表明未找到聊天室，400 表明聊天记录匹配失败，未更新。