Skip to content

Commit b976273

Browse files
committed
fix: update API request handling to use request body schema instead of query parameters
1 parent 886c45f commit b976273

File tree

2 files changed

+16
-28
lines changed

2 files changed

+16
-28
lines changed

apps/common/swagger_api/common_api.py

Lines changed: 15 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -15,33 +15,21 @@
1515
class CommonApi:
1616
class HitTestApi(ApiMixin):
1717
@staticmethod
18-
def get_request_params_api():
19-
return [
20-
openapi.Parameter(name='query_text',
21-
in_=openapi.IN_QUERY,
22-
type=openapi.TYPE_STRING,
23-
required=True,
24-
description=_('query text')),
25-
openapi.Parameter(name='top_number',
26-
in_=openapi.IN_QUERY,
27-
type=openapi.TYPE_NUMBER,
28-
default=10,
29-
required=True,
30-
description='topN'),
31-
openapi.Parameter(name='similarity',
32-
in_=openapi.IN_QUERY,
33-
type=openapi.TYPE_NUMBER,
34-
default=0.6,
35-
required=True,
36-
description=_('similarity')),
37-
openapi.Parameter(name='search_mode',
38-
in_=openapi.IN_QUERY,
39-
type=openapi.TYPE_STRING,
40-
default="embedding",
41-
required=True,
42-
description=_('Retrieval pattern embedding|keywords|blend')
43-
)
44-
]
18+
def get_request_body_api():
19+
return openapi.Schema(
20+
type=openapi.TYPE_OBJECT,
21+
required=['query_text', 'top_number', 'similarity', 'search_mode'],
22+
properties={
23+
'query_text': openapi.Schema(type=openapi.TYPE_STRING, title=_('query text'),
24+
description=_('query text')),
25+
'top_number': openapi.Schema(type=openapi.TYPE_NUMBER, title=_('top number'),
26+
description=_('top number')),
27+
'similarity': openapi.Schema(type=openapi.TYPE_NUMBER, title=_('similarity'),
28+
description=_('similarity')),
29+
'search_mode': openapi.Schema(type=openapi.TYPE_STRING, title=_('search mode'),
30+
description=_('search mode'))
31+
}
32+
)
4533

4634
@staticmethod
4735
def get_response_body_api():

apps/dataset/views/dataset.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ class HitTest(APIView):
142142

143143
@action(methods="PUT", detail=False)
144144
@swagger_auto_schema(operation_summary=_('Hit test list'), operation_id=_('Hit test list'),
145-
manual_parameters=CommonApi.HitTestApi.get_request_params_api(),
145+
request_body=CommonApi.HitTestApi.get_request_body_api(),
146146
responses=result.get_api_array_response(CommonApi.HitTestApi.get_response_body_api()),
147147
tags=[_('Knowledge Base')])
148148
@has_permissions(lambda r, keywords: Permission(group=Group.DATASET, operate=Operate.USE,

0 commit comments

Comments
 (0)