Skip to content

Commit 94c5c41

Browse files
liuruibinliuruibin
committed
fix: add type ignore comments for operation_id and tags in various API schemas
1 parent 1a34c67 commit 94c5c41

File tree

14 files changed

+203
-203
lines changed

14 files changed

+203
-203
lines changed

‎apps/folders/views/folder.py‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ class FolderView(APIView):
1818
methods=['POST'],
1919
description=_('Create folder'),
2020
summary=_('Create folder'),
21-
operation_id=_('Create folder'),
21+
operation_id=_('Create folder'), # type: ignore
2222
parameters=FolderCreateAPI.get_parameters(),
2323
request=FolderCreateAPI.get_request(),
2424
responses=FolderCreateAPI.get_response(),
25-
tags=[_('Folder')]
25+
tags=[_('Folder')] # type: ignore
2626
)
2727
@has_permissions(lambda r, kwargs: Permission(group=Group(kwargs.get('source')), operate=Operate.CREATE,
2828
resource_path=f"/WORKSPACE/{kwargs.get('workspace_id')}"))
@@ -37,10 +37,10 @@ def post(self, request: Request, workspace_id: str, source: str):
3737
methods=['GET'],
3838
description=_('Get folder tree'),
3939
summary=_('Get folder tree'),
40-
operation_id=_('Get folder tree'),
40+
operation_id=_('Get folder tree'), # type: ignore
4141
parameters=FolderTreeReadAPI.get_parameters(),
4242
responses=FolderTreeReadAPI.get_response(),
43-
tags=[_('Folder')]
43+
tags=[_('Folder')] # type: ignore
4444
)
4545
@has_permissions(lambda r, kwargs: Permission(group=Group(kwargs.get('source')), operate=Operate.READ,
4646
resource_path=f"/WORKSPACE/{kwargs.get('workspace_id')}"))
@@ -56,11 +56,11 @@ class Operate(APIView):
5656
methods=['PUT'],
5757
description=_('Update folder'),
5858
summary=_('Update folder'),
59-
operation_id=_('Update folder'),
59+
operation_id=_('Update folder'), # type: ignore
6060
parameters=FolderEditAPI.get_parameters(),
6161
request=FolderEditAPI.get_request(),
6262
responses=FolderEditAPI.get_response(),
63-
tags=[_('Folder')]
63+
tags=[_('Folder')] # type: ignore
6464
)
6565
@has_permissions(lambda r, kwargs: Permission(group=Group(kwargs.get('source')), operate=Operate.EDIT,
6666
resource_path=f"/WORKSPACE/{kwargs.get('workspace_id')}"))
@@ -73,10 +73,10 @@ def put(self, request: Request, workspace_id: str, source: str, folder_id: str):
7373
methods=['GET'],
7474
description=_('Get folder'),
7575
summary=_('Get folder'),
76-
operation_id=_('Get folder'),
76+
operation_id=_('Get folder'), # type: ignore
7777
parameters=FolderReadAPI.get_parameters(),
7878
responses=FolderReadAPI.get_response(),
79-
tags=[_('Folder')]
79+
tags=[_('Folder')] # type: ignore
8080
)
8181
@has_permissions(lambda r, kwargs: Permission(group=Group(kwargs.get('source')), operate=Operate.READ,
8282
resource_path=f"/WORKSPACE/{kwargs.get('workspace_id')}"))
@@ -89,10 +89,10 @@ def get(self, request: Request, workspace_id: str, source: str, folder_id: str):
8989
methods=['DELETE'],
9090
description=_('Delete folder'),
9191
summary=_('Delete folder'),
92-
operation_id=_('Delete folder'),
92+
operation_id=_('Delete folder'), # type: ignore
9393
parameters=FolderDeleteAPI.get_parameters(),
9494
responses=FolderDeleteAPI.get_response(),
95-
tags=[_('Folder')]
95+
tags=[_('Folder')] # type: ignore
9696
)
9797
@has_permissions(lambda r, kwargs: Permission(group=Group(kwargs.get('source')), operate=Operate.DELETE,
9898
resource_path=f"/WORKSPACE/{kwargs.get('workspace_id')}"))

‎apps/knowledge/views/document.py‎

Lines changed: 42 additions & 42 deletions
Large diffs are not rendered by default.

‎apps/knowledge/views/file.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ class FileView(APIView):
1919
methods=['POST'],
2020
summary=_('Upload file'),
2121
description=_('Upload file'),
22-
operation_id=_('Upload file'),
22+
operation_id=_('Upload file'), # type: ignore
2323
parameters=FileUploadAPI.get_parameters(),
2424
request=FileUploadAPI.get_request(),
2525
responses=FileUploadAPI.get_response(),
26-
tags=[_('File')]
26+
tags=[_('File')] # type: ignore
2727
)
2828
def post(self, request: Request):
2929
return result.success(FileSerializer(data={'file': request.FILES.get('file')}).upload())
@@ -33,10 +33,10 @@ class Operate(APIView):
3333
methods=['GET'],
3434
summary=_('Get file'),
3535
description=_('Get file'),
36-
operation_id=_('Get file'),
36+
operation_id=_('Get file'), # type: ignore
3737
parameters=FileGetAPI.get_parameters(),
3838
responses=FileGetAPI.get_response(),
39-
tags=[_('File')]
39+
tags=[_('File')] # type: ignore
4040
)
4141
def get(self, request: Request, file_id: str):
4242
return FileSerializer.Operate(data={'id': file_id}).get()
@@ -45,10 +45,10 @@ def get(self, request: Request, file_id: str):
4545
methods=['DELETE'],
4646
summary=_('Delete file'),
4747
description=_('Delete file'),
48-
operation_id=_('Delete file'),
48+
operation_id=_('Delete file'), # type: ignore
4949
parameters=FileGetAPI.get_parameters(),
5050
responses=FileGetAPI.get_response(),
51-
tags=[_('File')]
51+
tags=[_('File')] # type: ignore
5252
)
5353
def delete(self, request: Request, file_id: str):
5454
return result.success(FileSerializer.Operate(data={'id': file_id}).delete())

‎apps/knowledge/views/knowledge.py‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ class KnowledgeView(APIView):
1919
methods=['GET'],
2020
description=_('Get knowledge by folder'),
2121
summary=_('Get knowledge by folder'),
22-
operation_id=_('Get knowledge by folder'),
22+
operation_id=_('Get knowledge by folder'), # type: ignore
2323
parameters=KnowledgeTreeReadAPI.get_parameters(),
2424
responses=KnowledgeTreeReadAPI.get_response(),
25-
tags=[_('Knowledge Base')]
25+
tags=[_('Knowledge Base')] # type: ignore
2626
)
2727
@has_permissions(PermissionConstants.KNOWLEDGE_READ.get_workspace_permission())
2828
def get(self, request: Request, workspace_id: str):
@@ -43,11 +43,11 @@ class Operate(APIView):
4343
methods=['PUT'],
4444
description=_('Edit knowledge'),
4545
summary=_('Edit knowledge'),
46-
operation_id=_('Edit knowledge'),
46+
operation_id=_('Edit knowledge'), # type: ignore
4747
parameters=KnowledgeEditAPI.get_parameters(),
4848
request=KnowledgeEditAPI.get_request(),
4949
responses=KnowledgeEditAPI.get_response(),
50-
tags=[_('Knowledge Base')]
50+
tags=[_('Knowledge Base')] # type: ignore
5151
)
5252
@has_permissions(PermissionConstants.KNOWLEDGE_EDIT.get_workspace_permission())
5353
def put(self, request: Request, workspace_id: str, knowledge_id: str):
@@ -59,11 +59,11 @@ def put(self, request: Request, workspace_id: str, knowledge_id: str):
5959
methods=['DELETE'],
6060
description=_('Delete knowledge'),
6161
summary=_('Delete knowledge'),
62-
operation_id=_('Delete knowledge'),
62+
operation_id=_('Delete knowledge'), # type: ignore
6363
parameters=KnowledgeBaseCreateAPI.get_parameters(),
6464
request=KnowledgeBaseCreateAPI.get_request(),
6565
responses=KnowledgeBaseCreateAPI.get_response(),
66-
tags=[_('Knowledge Base')]
66+
tags=[_('Knowledge Base')] # type: ignore
6767
)
6868
@has_permissions(PermissionConstants.KNOWLEDGE_DELETE.get_workspace_permission())
6969
def delete(self, request: Request, workspace_id: str, knowledge_id: str):
@@ -75,10 +75,10 @@ def delete(self, request: Request, workspace_id: str, knowledge_id: str):
7575
methods=['GET'],
7676
description=_('Get knowledge'),
7777
summary=_('Get knowledge'),
78-
operation_id=_('Get knowledge'),
78+
operation_id=_('Get knowledge'), # type: ignore
7979
parameters=KnowledgeReadAPI.get_parameters(),
8080
responses=KnowledgeReadAPI.get_response(),
81-
tags=[_('Knowledge Base')]
81+
tags=[_('Knowledge Base')] # type: ignore
8282
)
8383
@has_permissions(PermissionConstants.KNOWLEDGE_DELETE.get_workspace_permission())
8484
def get(self, request: Request, workspace_id: str, knowledge_id: str):
@@ -93,10 +93,10 @@ class Page(APIView):
9393
methods=['GET'],
9494
description=_('Get the knowledge base paginated list'),
9595
summary=_('Get the knowledge base paginated list'),
96-
operation_id=_('Get the knowledge base paginated list'),
96+
operation_id=_('Get the knowledge base paginated list'), # type: ignore
9797
parameters=KnowledgePageAPI.get_parameters(),
9898
responses=KnowledgePageAPI.get_response(),
99-
tags=[_('Knowledge Base')]
99+
tags=[_('Knowledge Base')] # type: ignore
100100
)
101101
@has_permissions(PermissionConstants.KNOWLEDGE_READ.get_workspace_permission())
102102
def get(self, request: Request, workspace_id: str, current_page: int, page_size: int):
@@ -117,11 +117,11 @@ class SyncWeb(APIView):
117117
methods=['PUT'],
118118
summary=_("Synchronize the knowledge base of the website"),
119119
description=_("Synchronize the knowledge base of the website"),
120-
operation_id=_("Synchronize the knowledge base of the website"),
120+
operation_id=_("Synchronize the knowledge base of the website"), # type: ignore
121121
parameters=SyncWebAPI.get_parameters(),
122122
request=SyncWebAPI.get_request(),
123123
responses=SyncWebAPI.get_response(),
124-
tags=[_('Knowledge Base')]
124+
tags=[_('Knowledge Base')] # type: ignore
125125
)
126126
@has_permissions(PermissionConstants.KNOWLEDGE_EDIT.get_workspace_permission())
127127
def put(self, request: Request, workspace_id: str, knowledge_id: str):
@@ -141,11 +141,11 @@ class HitTest(APIView):
141141
methods=['PUT'],
142142
summary=_('Hit test list'),
143143
description=_('Hit test list'),
144-
operation_id=_('Hit test list'),
144+
operation_id=_('Hit test list'), # type: ignore
145145
parameters=HitTestAPI.get_parameters(),
146146
request=HitTestAPI.get_request(),
147147
responses=HitTestAPI.get_response(),
148-
tags=[_('Knowledge Base')]
148+
tags=[_('Knowledge Base')] # type: ignore
149149
)
150150
@has_permissions(PermissionConstants.KNOWLEDGE_EDIT.get_workspace_permission())
151151
def put(self, request: Request, workspace_id: str, knowledge_id: str):
@@ -168,11 +168,11 @@ class Embedding(APIView):
168168
methods=['PUT'],
169169
summary=_('Re-vectorize'),
170170
description=_('Re-vectorize'),
171-
operation_id=_('Re-vectorize'),
171+
operation_id=_('Re-vectorize'), # type: ignore
172172
parameters=EmbeddingAPI.get_parameters(),
173173
request=EmbeddingAPI.get_request(),
174174
responses=EmbeddingAPI.get_response(),
175-
tags=[_('Knowledge Base')]
175+
tags=[_('Knowledge Base')] # type: ignore
176176
)
177177
@has_permissions(PermissionConstants.KNOWLEDGE_EDIT.get_workspace_permission())
178178
def put(self, request: Request, workspace_id: str, knowledge_id: str):
@@ -187,11 +187,11 @@ class GenerateRelated(APIView):
187187
methods=['PUT'],
188188
summary=_('Generate related'),
189189
description=_('Generate related'),
190-
operation_id=_('Generate related'),
190+
operation_id=_('Generate related'), # type: ignore
191191
parameters=GenerateRelatedAPI.get_parameters(),
192192
request=GenerateRelatedAPI.get_request(),
193193
responses=GenerateRelatedAPI.get_response(),
194-
tags=[_('Knowledge Base')]
194+
tags=[_('Knowledge Base')] # type: ignore
195195
)
196196
def put(self, request: Request, workspace_id: str, knowledge_id: str):
197197
return result.success(KnowledgeSerializer.Operate(
@@ -206,11 +206,11 @@ class KnowledgeBaseView(APIView):
206206
methods=['POST'],
207207
description=_('Create base knowledge'),
208208
summary=_('Create base knowledge'),
209-
operation_id=_('Create base knowledge'),
209+
operation_id=_('Create base knowledge'), # type: ignore
210210
parameters=KnowledgeBaseCreateAPI.get_parameters(),
211211
request=KnowledgeBaseCreateAPI.get_request(),
212212
responses=KnowledgeBaseCreateAPI.get_response(),
213-
tags=[_('Knowledge Base')]
213+
tags=[_('Knowledge Base')] # type: ignore
214214
)
215215
@has_permissions(PermissionConstants.KNOWLEDGE_CREATE.get_workspace_permission())
216216
def post(self, request: Request, workspace_id: str):
@@ -226,11 +226,11 @@ class KnowledgeWebView(APIView):
226226
methods=['POST'],
227227
description=_('Create web knowledge'),
228228
summary=_('Create web knowledge'),
229-
operation_id=_('Create web knowledge'),
229+
operation_id=_('Create web knowledge'), # type: ignore
230230
parameters=KnowledgeWebCreateAPI.get_parameters(),
231231
request=KnowledgeWebCreateAPI.get_request(),
232232
responses=KnowledgeWebCreateAPI.get_response(),
233-
tags=[_('Knowledge Base')]
233+
tags=[_('Knowledge Base')] # type: ignore
234234
)
235235
@has_permissions(PermissionConstants.KNOWLEDGE_CREATE.get_workspace_permission())
236236
def post(self, request: Request, workspace_id: str):

0 commit comments

Comments
 (0)