chore: add wrapper response entries for results and pagination

teamkeel · Sep 13, 2024 · e1d1792 · e1d1792
1 parent 9ad728d
commit e1d1792
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 0 deletions.
diff --git a/tools/generator.go b/tools/generator.go
@@ -346,6 +346,13 @@ func (g *Generator) generateResponses() error {
 		if tool.Action.IsList() {
 			pathPrefix = ".results[*]"
 			tool.Config.Response = append(tool.Config.Response, getPageInfoResponses()...)
+			// appent wrapper response for the results
+			tool.Config.Response = append(tool.Config.Response, &toolsproto.ResponseFieldConfig{
+				FieldLocation: &toolsproto.JsonPath{Path: "$.results"},
+				FieldType:     proto.Type_TYPE_OBJECT,
+				DisplayName:   "Results",
+				Visible:       true,
+			})
 		}
 		fields, err := g.makeResponsesForModel(tool.Model, pathPrefix, tool.Action.GetResponseEmbeds(), tool.SortableFields)
 		if err != nil {
@@ -657,6 +664,12 @@ func (g *Generator) makeTitle(action *proto.Action, model *proto.Model) *toolspr
 // getPageInfoResponses will return the responses for pageInfo (by default available on all autogenerated LIST actions)
 func getPageInfoResponses() []*toolsproto.ResponseFieldConfig {
 	return []*toolsproto.ResponseFieldConfig{
+		{
+			FieldLocation: &toolsproto.JsonPath{Path: "$.pageInfo"},
+			FieldType:     proto.Type_TYPE_OBJECT,
+			DisplayName:   "PageInfo",
+			Visible:       false,
+		},
 		{
 			FieldLocation: &toolsproto.JsonPath{Path: "$.pageInfo.count"},
 			FieldType:     proto.Type_TYPE_INT,

diff --git a/tools/testdata/blog/tools.json b/tools/testdata/blog/tools.json
@@ -552,6 +552,11 @@
         }
       ],
       "response": [
+        {
+          "fieldLocation": { "path": "$.pageInfo" },
+          "fieldType": "TYPE_OBJECT",
+          "displayName": "PageInfo"
+        },
         {
           "fieldLocation": { "path": "$.pageInfo.count" },
           "fieldType": "TYPE_INT",
@@ -577,6 +582,12 @@
           "fieldType": "TYPE_STRING",
           "displayName": "End cursor"
         },
+        {
+          "fieldLocation": { "path": "$.results" },
+          "fieldType": "TYPE_OBJECT",
+          "displayName": "Results",
+          "visible": true
+        },
         {
           "fieldLocation": { "path": "$.results[*].name" },
           "fieldType": "TYPE_STRING",
@@ -716,6 +727,11 @@
         }
       ],
       "response": [
+        {
+          "fieldLocation": { "path": "$.pageInfo" },
+          "fieldType": "TYPE_OBJECT",
+          "displayName": "PageInfo"
+        },
         {
           "fieldLocation": { "path": "$.pageInfo.count" },
           "fieldType": "TYPE_INT",
@@ -741,6 +757,12 @@
           "fieldType": "TYPE_STRING",
           "displayName": "End cursor"
         },
+        {
+          "fieldLocation": { "path": "$.results" },
+          "fieldType": "TYPE_OBJECT",
+          "displayName": "Results",
+          "visible": true
+        },
         {
           "fieldLocation": { "path": "$.results[*].content" },
           "fieldType": "TYPE_STRING",
@@ -851,6 +873,11 @@
         }
       ],
       "response": [
+        {
+          "fieldLocation": { "path": "$.pageInfo" },
+          "fieldType": "TYPE_OBJECT",
+          "displayName": "PageInfo"
+        },
         {
           "fieldLocation": { "path": "$.pageInfo.count" },
           "fieldType": "TYPE_INT",
@@ -876,6 +903,12 @@
           "fieldType": "TYPE_STRING",
           "displayName": "End cursor"
         },
+        {
+          "fieldLocation": { "path": "$.results" },
+          "fieldType": "TYPE_OBJECT",
+          "displayName": "Results",
+          "visible": true
+        },
         {
           "fieldLocation": { "path": "$.results[*].title" },
           "fieldType": "TYPE_STRING",
@@ -1038,6 +1071,11 @@
         }
       ],
       "response": [
+        {
+          "fieldLocation": { "path": "$.pageInfo" },
+          "fieldType": "TYPE_OBJECT",
+          "displayName": "PageInfo"
+        },
         {
           "fieldLocation": { "path": "$.pageInfo.count" },
           "fieldType": "TYPE_INT",
@@ -1063,6 +1101,12 @@
           "fieldType": "TYPE_STRING",
           "displayName": "End cursor"
         },
+        {
+          "fieldLocation": { "path": "$.results" },
+          "fieldType": "TYPE_OBJECT",
+          "displayName": "Results",
+          "visible": true
+        },
         {
           "fieldLocation": { "path": "$.results[*].title" },
           "fieldType": "TYPE_STRING",