Skip to content

refactor: move chat share endpoints to chat API routes and remove workspace_id from share-link flow #4817

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zhanweizhang7 merged 1 commit into from
Feb 24, 2026
+5 −13
Merged

refactor: move chat share endpoints to chat API routes and remove workspace_id from share-link flow #4817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions apps/application/api/application_chat_link.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,6 @@ def get_request():
@staticmethod
def get_parameters():
return [
OpenApiParameter(
name="workspace_id",
description="工作空间id",
type=OpenApiTypes.STR,
location='path',
required=True,
),
OpenApiParameter(
name="application_id",
description="Application ID",
Copy link
Contributor Author

@shaohuzhang1 shaohuzhang1 Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The provided code snippet is mostly correct but contains a redundant section regarding the workspace_id parameter. Since the parameter is defined within the method get request(), which suggests it's intended to be dynamic and not static, removing this section should resolve any redundancy. Here are the changes:

def get_request():
    parameters = [
        OpenApiParameter(
            name="application_id",
            description="Application ID",
            type=OpenApiTypes.STR,
            location='path',
            required=True,
        ),
    ]

No further optimization suggestions are needed based on the information provided. If you plan to include more parameters dynamically in future versions of the function, make sure they are added here as well.

Expand Down
1 change: 0 additions & 1 deletion apps/application/serializers/application_chat_link.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ def validate(self, attrs):

class ChatRecordShareLinkSerializer(serializers.Serializer):
chat_id = serializers.UUIDField(required=True, label=_("Conversation ID"))
workspace_id = serializers.CharField(required=False, allow_null=True, allow_blank=True, label=_("Workspace ID"))
application_id = serializers.UUIDField(required=True, label=_("Application ID"))
user_id = serializers.UUIDField(required=False, label=_("User ID"))

Expand Down
2 changes: 0 additions & 2 deletions apps/application/urls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
path('workspace/<str:workspace_id>/application/<str:application_id>/chat', views.ApplicationChat.as_view()),
path('workspace/<str:workspace_id>/application/<str:application_id>/chat/export', views.ApplicationChat.Export.as_view()),
path('workspace/<str:workspace_id>/application/<str:application_id>/chat/<int:current_page>/<int:page_size>', views.ApplicationChat.Page.as_view()),
path('workspace/<str:workspace_id>/application/<str:application_id>/chat/<str:chat_id>/share_chat', views.ChatRecordLinkView.as_view()),
path('workspace/<str:workspace_id>/application/<str:application_id>/chat/<str:chat_id>/chat_record', views.ApplicationChatRecord.as_view()),
path('workspace/<str:workspace_id>/application/<str:application_id>/chat/<str:chat_id>/chat_record/<str:chat_record_id>', views.ApplicationChatRecordOperateAPI.as_view()),
path('workspace/<str:workspace_id>/application/<str:application_id>/chat/<str:chat_id>/chat_record/<int:current_page>/<int:page_size>', views.ApplicationChatRecord.Page.as_view()),
Expand All @@ -40,5 +39,4 @@
path('workspace/<str:workspace_id>/application/<str:application_id>/mcp_tools', views.McpServers.as_view()),
path('workspace/<str:workspace_id>/application/<str:application_id>/model/<str:model_id>/prompt_generate', views.PromptGenerateView.as_view()),
path('chat_message/<str:chat_id>', views.ChatView.as_view()),
path('chat/share/<str:link>', views.ChatRecordDetailView.as_view()),
]
3 changes: 1 addition & 2 deletions apps/application/views/application_chat_link.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,8 @@ class ChatRecordLinkView(APIView):
tags=[_("Chat record link")] # type: ignore
)

def post(self, request: Request, workspace_id: str, application_id: str, chat_id: str):
def post(self, request: Request, application_id: str, chat_id: str):
return result.success(ChatRecordShareLinkSerializer(data={
"workspace_id": workspace_id,
"application_id": application_id,
"chat_id": chat_id,
"user_id": request.auth.chat_user_id
Copy link
Contributor Author

@shaohuzhang1 shaohuzhang1 Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The given code has a few potential issues that need to be addressed:

  1. Unused Variable: The variable workspace_id is defined but never used in the method after being passed to it. This suggests there might not be a requirement for this parameter.

  2. Unnecessary Type Hinting: The line "tags=[_("Chat record link")] # type: ignore" seems unnecessary as long as the _ function returns translatable strings. Remove this if no translation errors occur.

  3. Code Readability: Some of the lines have inconsistent spacing, which can make them harder to read and understand. Ensure consistent formatting throughout the file.

Here's an optimized version of the code with these improvements:

class ChatRecordLinkView(APIView):
    tags = [_("Chat record link")]

    def post(self, request: Request, application_id: str, chat_id: str) -> Response:
        return result.success(
            {
                "application_id": application_id,
                "chat_id": chat_id,
                "user_id": request.auth.chat_user_id,
            }
        )

Explanation:

  • Removed the unused workspace_id from the POST endpoint parameters.
  • Simplified the success response dictionary to use shorter key names (application_id, chat_id) as their values match exactly with the field names in the serializer.
  • Added type hints for the return value to explicitly indicate what the method returns, making the code more readable and maintainable.

Expand Down
5 changes: 4 additions & 1 deletion apps/chat/urls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
from django.urls import path

from application.views import ChatRecordDetailView, ChatRecordLinkView
from chat.views.mcp import mcp_view
from . import views

Expand All @@ -24,5 +25,7 @@
path('historical_conversation/clear',views.HistoricalConversationView.BatchDelete.as_view(), name='historical_conversation_clear'),
path('historical_conversation/<str:chat_id>',views.HistoricalConversationView.Operate.as_view(), name='historical_conversation_operate'),
path('historical_conversation_record/<str:chat_id>', views.HistoricalConversationRecordView.as_view(), name='historical_conversation_record'),
path('historical_conversation_record/<str:chat_id>/<int:current_page>/<int:page_size>', views.HistoricalConversationRecordView.PageView.as_view(), name='historical_conversation_record')
path('historical_conversation_record/<str:chat_id>/<int:current_page>/<int:page_size>', views.HistoricalConversationRecordView.PageView.as_view(), name='historical_conversation_record'),
path('share/<str:link>', ChatRecordDetailView.as_view()),
path('<str:application_id>/chat/<str:chat_id>/share_chat', ChatRecordLinkView.as_view()),
]
Copy link
Contributor Author

@shaohuzhang1 shaohuzhang1 Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here are some recommendations and optimizations:

  1. URL Naming Convention: It's generally a good practice to use descriptive names for URL patterns when they correspond to specific actions (e.g., chat_record_detail instead of ShareChat).

  2. Redundant Path Patterns: The pattern '/social/share' is similar to 'share/<str:link>', which suggests redundancy or confusion. Consider making them more distinct.

  3. Simplify Redundant Imports: Since both URLs map to ChatRecordDetailView, consider importing it once at the top level rather than within each path group.

  4. Add Documentation Comments: Include comments explaining what each URL does, especially if they contain multiple parameters.

  5. Error Handling: Ensure that error handling is set up correctly on backend APIs if necessary.

  6. Consider Using Regular Expressions for More Specific Paths: If certain paths share common parts, using regular expressions can make the definition cleaner.

Here’s an optimized version with improved naming conventions and clarity:

from django.urls import include, re_path

app_name = 'history'

urlpatterns = [
    # Other existing paths here...
    
    # Simplified historical conversation record endpoint
    path('historical_conversations/<str:chat_id>', 
         views.HistoricalConversationListView.as_view(),
         name='historical_conversations'),

    # Add documentation comments
    """
    Path for displaying detailed information about a chat.
    
    Args:
        chat_id (str): The unique identifier for the chat.

    Returns:
        JsonResponse: Detailed view of the chat record.
    """
    path("share/<int:pk>/", ChatRecordDetailView.as_view(), name="shared-chat-detail"),
    
    """
    Endpoint for creating links for sharing chats.
    
    Args:
        application_id (str): ID of the application associated with the chat.
        chat_id (str): Unique identifier of the chat being shared.

    Returns:
        HttpResponse: Redirect response with link creation success status messages.
    """
    path("<str:application_id>/chat/<str:chat_id>/create-link/", 
         create_share_link,  # Assuming this function exists elsewhere
         name="create-share-link"),

]