Merge pull request #2944 from actiontech/2247

api definition: add filter on get graph API

Author: littleniannian

sqle/api/controller/v1/knowledge_base.go

@@ -72,13 +72,19 @@ func GetKnowledgeBaseTagList(c echo.Context) error {
 // @Description get knowledge graph
 // @Id getKnowledgeGraph
 // @Tags knowledge_base
+// @Param filter_by_rule_name query string false "filter by rule name"
 // @Security ApiKeyAuth
 // @Success 200 {object} v1.GetKnowledgeGraphResp
 // @router /v1/knowledge_bases/graph [get]
 func GetKnowledgeGraph(c echo.Context) error {
 	return getKnowledgeGraph(c)
 }
 
+// 获取知识图谱请求
+type GetKnowledgeGraphReq struct {
+	FilterByRuleName string `json:"filter_by_rule_name" query:"filter_by_rule_name"` // 根据规则名称过滤
+}
+
 type GetKnowledgeGraphResp struct {
 	controller.BaseRes
 	Data *GraphResponse `json:"data"`

sqle/docs/docs.go

@@ -1439,6 +1439,14 @@ var doc = `{
                 ],
                 "summary": "获取知识库知识图谱",
                 "operationId": "getKnowledgeGraph",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "filter by rule name",
+                        "name": "filter_by_rule_name",
+                        "in": "query"
+                    }
+                ],
                 "responses": {
                     "200": {
                         "description": "OK",

sqle/docs/swagger.json

@@ -1423,6 +1423,14 @@
                 ],
                 "summary": "获取知识库知识图谱",
                 "operationId": "getKnowledgeGraph",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "filter by rule name",
+                        "name": "filter_by_rule_name",
+                        "in": "query"
+                    }
+                ],
                 "responses": {
                     "200": {
                         "description": "OK",

sqle/docs/swagger.yaml

@@ -7427,6 +7427,11 @@ paths:
     get:
       description: get knowledge graph
       operationId: getKnowledgeGraph
+      parameters:
+      - description: filter by rule name
+        in: query
+        name: filter_by_rule_name
+        type: string
       responses:
         "200":
           description: OK