From b2b1e0767843ec7d881329a155608f894d210cf7 Mon Sep 17 00:00:00 2001
From: Wing-Kam Wong <wingkwong.code@gmail.com>
Date: Mon, 13 Mar 2023 13:03:08 +0800
Subject: [PATCH] refactor(nocodb): hook response & example

---
 packages/nocodb/src/schema/swagger.json | 59 ++++++++++++++++++++++++-
 1 file changed, 58 insertions(+), 1 deletion(-)

diff --git a/packages/nocodb/src/schema/swagger.json b/packages/nocodb/src/schema/swagger.json
index eefb7b81d2..c5d6a581a8 100644
--- a/packages/nocodb/src/schema/swagger.json
+++ b/packages/nocodb/src/schema/swagger.json
@@ -10994,7 +10994,25 @@
             "description": "OK",
             "content": {
               "application/json": {
-                "schema": {}
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "msg": {
+                      "type": "string",
+                      "x-stoplight": {
+                        "id": "l5k90tzuvvv1g"
+                      },
+                      "example": "The hook has been tested successfully"
+                    }
+                  }
+                },
+                "examples": {
+                  "Example 1": {
+                    "value": {
+                      "msg": "The hook has been tested successfully"
+                    }
+                  }
+                }
               }
             }
           },
@@ -11008,6 +11026,45 @@
             "application/json": {
               "schema": {
                 "$ref": "#/components/schemas/HookTestReq"
+              },
+              "examples": {
+                "Example 1": {
+                  "value": {
+                    "hook": {
+                      "active": 0,
+                      "async": 0,
+                      "description": "This is my hook description",
+                      "env": "all",
+                      "event": "after",
+                      "fk_model_id": "md_rsu68aqjsbyqtl",
+                      "id": "string",
+                      "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}",
+                      "null": null,
+                      "operation": "insert",
+                      "retries": 10,
+                      "retry_interval": 60000,
+                      "timeout": 60000,
+                      "title": "My Webhook"
+                    },
+                    "payload": {
+                      "data": {
+                        "Id": 1,
+                        "Title": "Sample Text",
+                        "CreatedAt": "2023-03-03T10:03:06.484Z",
+                        "UpdatedAt": "2023-03-03T10:03:06.484Z",
+                        "attachment": [
+                          {
+                            "url": "https://nocodb.com/dummy.png",
+                            "title": "image.png",
+                            "mimetype": "image/png",
+                            "size": 0
+                          }
+                        ],
+                        "f": "Sample Output"
+                      }
+                    }
+                  }
+                }
               }
             }
           }