From 0e66b8a186be634c51d76c2dc1035fdbc9adf705 Mon Sep 17 00:00:00 2001 From: CaptainB Date: Tue, 6 May 2025 13:54:42 +0800 Subject: [PATCH] feat: add summary fields to extend_schema for folder and document APIs --- apps/folders/views/folder.py | 5 +++++ apps/knowledge/views/__init__.py | 2 +- apps/knowledge/views/document.py | 9 +++++++++ apps/knowledge/views/knowledge.py | 7 +++++++ apps/tools/views/tool.py | 9 +++++++++ 5 files changed, 31 insertions(+), 1 deletion(-) diff --git a/apps/folders/views/folder.py b/apps/folders/views/folder.py index 9786b1143..a336b3689 100644 --- a/apps/folders/views/folder.py +++ b/apps/folders/views/folder.py @@ -17,6 +17,7 @@ class FolderView(APIView): @extend_schema( methods=['POST'], description=_('Create folder'), + summary=_('Create folder'), operation_id=_('Create folder'), parameters=FolderCreateAPI.get_parameters(), request=FolderCreateAPI.get_request(), @@ -35,6 +36,7 @@ class FolderView(APIView): @extend_schema( methods=['GET'], description=_('Get folder tree'), + summary=_('Get folder tree'), operation_id=_('Get folder tree'), parameters=FolderTreeReadAPI.get_parameters(), responses=FolderTreeReadAPI.get_response(), @@ -53,6 +55,7 @@ class FolderView(APIView): @extend_schema( methods=['PUT'], description=_('Update folder'), + summary=_('Update folder'), operation_id=_('Update folder'), parameters=FolderEditAPI.get_parameters(), request=FolderEditAPI.get_request(), @@ -69,6 +72,7 @@ class FolderView(APIView): @extend_schema( methods=['GET'], description=_('Get folder'), + summary=_('Get folder'), operation_id=_('Get folder'), parameters=FolderReadAPI.get_parameters(), responses=FolderReadAPI.get_response(), @@ -84,6 +88,7 @@ class FolderView(APIView): @extend_schema( methods=['DELETE'], description=_('Delete folder'), + summary=_('Delete folder'), operation_id=_('Delete folder'), parameters=FolderDeleteAPI.get_parameters(), responses=FolderDeleteAPI.get_response(), diff --git a/apps/knowledge/views/__init__.py b/apps/knowledge/views/__init__.py index ce309a4e5..7a38bb5a3 100644 --- a/apps/knowledge/views/__init__.py +++ b/apps/knowledge/views/__init__.py @@ -1,2 +1,2 @@ -from .knowledge import * from .document import * +from .knowledge import * diff --git a/apps/knowledge/views/document.py b/apps/knowledge/views/document.py index 926d1c1ea..ecabcff40 100644 --- a/apps/knowledge/views/document.py +++ b/apps/knowledge/views/document.py @@ -20,6 +20,7 @@ class DocumentView(APIView): @extend_schema( methods=['POST'], description=_('Create document'), + summary=_('Create document'), operation_id=_('Create document'), request=DocumentCreateAPI.get_request(), parameters=DocumentCreateAPI.get_parameters(), @@ -36,6 +37,7 @@ class DocumentView(APIView): @extend_schema( methods=['GET'], description=_('Get document'), + summary=_('Get document'), operation_id=_('Get document'), parameters=KnowledgeTreeReadAPI.get_parameters(), responses=KnowledgeTreeReadAPI.get_response(), @@ -59,6 +61,7 @@ class DocumentView(APIView): @extend_schema( description=_('Get document details'), + summary=_('Get document details'), operation_id=_('Get document details'), parameters=DocumentReadAPI.get_parameters(), responses=DocumentReadAPI.get_response(), @@ -72,6 +75,7 @@ class DocumentView(APIView): @extend_schema( description=_('Modify document'), + summary=_('Modify document'), operation_id=_('Modify document'), parameters=DocumentEditAPI.get_parameters(), request=DocumentEditAPI.get_request(), @@ -87,6 +91,7 @@ class DocumentView(APIView): @extend_schema( description=_('Delete document'), + summary=_('Delete document'), operation_id=_('Delete document'), parameters=DocumentDeleteAPI.get_parameters(), responses=DocumentDeleteAPI.get_response(), @@ -105,6 +110,7 @@ class DocumentView(APIView): @extend_schema( methods=['POST'], description=_('Segmented document'), + summary=_('Segmented document'), operation_id=_('Segmented document'), parameters=DocumentSplitAPI.get_parameters(), request=DocumentSplitAPI.get_request(), @@ -136,6 +142,7 @@ class DocumentView(APIView): @extend_schema( methods=['POST'], description=_('Create documents in batches'), + summary=_('Create documents in batches'), operation_id=_('Create documents in batches'), request=DocumentBatchCreateAPI.get_request(), parameters=DocumentBatchCreateAPI.get_parameters(), @@ -154,6 +161,7 @@ class DocumentView(APIView): @extend_schema( methods=['PUT'], description=_('Batch sync documents'), + summary=_('Batch sync documents'), operation_id=_('Batch sync documents'), request=DocumentBatchAPI.get_request(), parameters=DocumentBatchAPI.get_parameters(), @@ -172,6 +180,7 @@ class DocumentView(APIView): @extend_schema( methods=['DELETE'], description=_('Delete documents in batches'), + summary=_('Delete documents in batches'), operation_id=_('Delete documents in batches'), request=DocumentBatchAPI.get_request(), parameters=DocumentBatchAPI.get_parameters(), diff --git a/apps/knowledge/views/knowledge.py b/apps/knowledge/views/knowledge.py index e97891888..ec421b34e 100644 --- a/apps/knowledge/views/knowledge.py +++ b/apps/knowledge/views/knowledge.py @@ -18,6 +18,7 @@ class KnowledgeView(APIView): @extend_schema( methods=['GET'], description=_('Get knowledge by folder'), + summary=_('Get knowledge by folder'), operation_id=_('Get knowledge by folder'), parameters=KnowledgeTreeReadAPI.get_parameters(), responses=KnowledgeTreeReadAPI.get_response(), @@ -41,6 +42,7 @@ class KnowledgeView(APIView): @extend_schema( methods=['PUT'], description=_('Edit knowledge'), + summary=_('Edit knowledge'), operation_id=_('Edit knowledge'), parameters=KnowledgeEditAPI.get_parameters(), request=KnowledgeEditAPI.get_request(), @@ -56,6 +58,7 @@ class KnowledgeView(APIView): @extend_schema( methods=['DELETE'], description=_('Delete knowledge'), + summary=_('Delete knowledge'), operation_id=_('Delete knowledge'), parameters=KnowledgeBaseCreateAPI.get_parameters(), request=KnowledgeBaseCreateAPI.get_request(), @@ -71,6 +74,7 @@ class KnowledgeView(APIView): @extend_schema( methods=['GET'], description=_('Get knowledge'), + summary=_('Get knowledge'), operation_id=_('Get knowledge'), parameters=KnowledgeReadAPI.get_parameters(), responses=KnowledgeReadAPI.get_response(), @@ -88,6 +92,7 @@ class KnowledgeView(APIView): @extend_schema( methods=['GET'], description=_('Get the knowledge base paginated list'), + summary=_('Get the knowledge base paginated list'), operation_id=_('Get the knowledge base paginated list'), parameters=KnowledgePageAPI.get_parameters(), responses=KnowledgePageAPI.get_response(), @@ -112,6 +117,7 @@ class KnowledgeBaseView(APIView): @extend_schema( methods=['POST'], description=_('Create base knowledge'), + summary=_('Create base knowledge'), operation_id=_('Create base knowledge'), parameters=KnowledgeBaseCreateAPI.get_parameters(), request=KnowledgeBaseCreateAPI.get_request(), @@ -131,6 +137,7 @@ class KnowledgeWebView(APIView): @extend_schema( methods=['POST'], description=_('Create web knowledge'), + summary=_('Create web knowledge'), operation_id=_('Create web knowledge'), parameters=KnowledgeWebCreateAPI.get_parameters(), request=KnowledgeWebCreateAPI.get_request(), diff --git a/apps/tools/views/tool.py b/apps/tools/views/tool.py index 20aee12d9..e6225bc98 100644 --- a/apps/tools/views/tool.py +++ b/apps/tools/views/tool.py @@ -19,6 +19,7 @@ class ToolView(APIView): @extend_schema( methods=['POST'], description=_('Create tool'), + summary=_('Create tool'), operation_id=_('Create tool'), parameters=ToolCreateAPI.get_parameters(), request=ToolCreateAPI.get_request(), @@ -34,6 +35,7 @@ class ToolView(APIView): @extend_schema( methods=['GET'], description=_('Get tool by folder'), + summary=_('Get tool by folder'), operation_id=_('Get tool by folder'), parameters=ToolTreeReadAPI.get_parameters(), responses=ToolTreeReadAPI.get_response(), @@ -51,6 +53,7 @@ class ToolView(APIView): @extend_schema( methods=['POST'], description=_('Debug Tool'), + summary=_('Debug Tool'), operation_id=_('Debug Tool'), request=ToolDebugApi.get_request(), responses=ToolDebugApi.get_response(), @@ -68,6 +71,7 @@ class ToolView(APIView): @extend_schema( methods=['PUT'], description=_('Update tool'), + summary=_('Update tool'), operation_id=_('Update tool'), parameters=ToolEditAPI.get_parameters(), request=ToolEditAPI.get_request(), @@ -83,6 +87,7 @@ class ToolView(APIView): @extend_schema( methods=['GET'], description=_('Get tool'), + summary=_('Get tool'), operation_id=_('Get tool'), parameters=ToolReadAPI.get_parameters(), responses=ToolReadAPI.get_response(), @@ -97,6 +102,7 @@ class ToolView(APIView): @extend_schema( methods=['DELETE'], description=_('Delete tool'), + summary=_('Delete tool'), operation_id=_('Delete tool'), parameters=ToolDeleteAPI.get_parameters(), responses=ToolDeleteAPI.get_response(), @@ -114,6 +120,7 @@ class ToolView(APIView): @extend_schema( methods=['GET'], description=_('Get tool list by pagination'), + summary=_('Get tool list by pagination'), operation_id=_('Get tool list by pagination'), parameters=ToolPageAPI.get_parameters(), responses=ToolPageAPI.get_response(), @@ -137,6 +144,7 @@ class ToolView(APIView): @extend_schema( methods=['POST'], description=_("Import tool"), + summary=_("Import tool"), operation_id=_("Import tool"), parameters=ToolImportAPI.get_parameters(), request=ToolImportAPI.get_request(), @@ -155,6 +163,7 @@ class ToolView(APIView): @extend_schema( methods=['GET'], description=_("Export tool"), + summary=_("Export tool"), operation_id=_("Export tool"), parameters=ToolExportAPI.get_parameters(), responses=ToolExportAPI.get_response(),