Skip to content

Commit 576431d

Browse files
authored
Refactor: Change update doc from PUT to patch (infiniflow#14067)
### What problem does this PR solve? Before change, update_document in api/apps/restful_apis/document_api.py is using "PUT". After change, it will use "PATCH" which is more suitable. ### Type of change - [x] Refactoring
1 parent 57aec2e commit 576431d

7 files changed

Lines changed: 16 additions & 25 deletions

File tree

admin/client/ragflow_client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1623,7 +1623,7 @@ def set_metadata(self, command_dict):
16231623
}
16241624

16251625
response = self.http_client.request(
1626-
"PUT",
1626+
"PATCH",
16271627
f"/datasets/{dataset_id}/documents/{doc_id}",
16281628
json_body=payload,
16291629
use_api_base=True,

api/apps/restful_apis/document_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
UpdateDocumentReq, format_validation_error_message,
3333
)
3434

35-
@manager.route("/datasets/<dataset_id>/documents/<document_id>", methods=["PUT"]) # noqa: F821
35+
@manager.route("/datasets/<dataset_id>/documents/<document_id>", methods=["PATCH"]) # noqa: F821
3636
@login_required
3737
@add_tenant_id_to_kwargs
3838
async def update_document(tenant_id, dataset_id, document_id):

sdk/python/ragflow_sdk/modules/document.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ def update(self, update_message: dict):
5454
if "meta_fields" in update_message:
5555
if not isinstance(update_message["meta_fields"], dict):
5656
raise Exception("meta_fields must be a dictionary")
57-
res = self.put(f"/datasets/{self.dataset_id}/documents/{self.id}", update_message)
57+
res = self.patch(f"/datasets/{self.dataset_id}/documents/{self.id}", update_message)
5858
res = res.json()
5959
if res.get("code") != 0:
6060
raise Exception(res["message"])

test/testcases/test_http_api/common.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ def list_documents(auth, dataset_id, params=None):
122122

123123
def update_document(auth, dataset_id, document_id, payload=None):
124124
url = f"{HOST_ADDRESS}{FILE_API_URL}/{document_id}".format(dataset_id=dataset_id)
125-
res = requests.put(url=url, headers=HEADERS, auth=auth, json=payload)
125+
res = requests.patch(url=url, headers=HEADERS, auth=auth, json=payload)
126126
return res.json()
127127

128128

web/src/pages/agents/agent-templates.tsx

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -79,18 +79,16 @@ export default function AgentTemplates() {
7979
return templateList;
8080
}
8181
const selectedCanvasType = selectMenuItem.toLocaleLowerCase();
82-
return templateList.filter(
83-
(item) => {
84-
if (Array.isArray(item.canvas_types) && item.canvas_types.length > 0) {
85-
return item.canvas_types.some(
86-
(canvasType) =>
87-
typeof canvasType === 'string' &&
88-
canvasType.toLocaleLowerCase() === selectedCanvasType,
89-
);
90-
}
91-
return item.canvas_type?.toLocaleLowerCase() === selectedCanvasType;
92-
},
93-
);
82+
return templateList.filter((item) => {
83+
if (Array.isArray(item.canvas_types) && item.canvas_types.length > 0) {
84+
return item.canvas_types.some(
85+
(canvasType) =>
86+
typeof canvasType === 'string' &&
87+
canvasType.toLocaleLowerCase() === selectedCanvasType,
88+
);
89+
}
90+
return item.canvas_type?.toLocaleLowerCase() === selectedCanvasType;
91+
});
9492
}, [selectMenuItem, templateList]);
9593

9694
return (

web/src/services/knowledge-service.ts

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ const {
2727
switchChunk,
2828
rmChunk,
2929
retrievalTest,
30-
documentRename,
3130
documentRun,
3231
documentUpload,
3332
webCrawl,
@@ -75,10 +74,6 @@ const methods = {
7574
url: documentRm,
7675
method: 'post',
7776
},
78-
documentRename: {
79-
url: documentRename,
80-
method: 'put',
81-
},
8277
documentCreate: {
8378
url: documentCreate,
8479
method: 'post',
@@ -255,7 +250,7 @@ export const renameDocument = (
255250
datasetId: string,
256251
documentId: string,
257252
data: { name?: string },
258-
) => request.put(api.documentRename(datasetId, documentId), { data });
253+
) => request.patch(api.documentRename(datasetId, documentId), { data });
259254

260255
export const getMetaDataService = ({
261256
kb_id,

web/src/services/plugin-service.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@ import api from '@/utils/api';
22
import registerServer from '@/utils/register-server';
33
import request from '@/utils/request';
44

5-
const {
6-
llmTools
7-
} = api;
5+
const { llmTools } = api;
86

97
const methods = {
108
getLlmTools: {

0 commit comments

Comments
 (0)