[ISSUE #111] queryWebHookConfigByManufacturer endpoint causes NPE and…

… unable to response Co-authored-by: xiatian5 <xiatian5@lenovo.com>
apache · Jul 28, 2023 · ca30f5d · ca30f5d
1 parent efdc82c
commit ca30f5d
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 9 deletions.
diff --git a/docs/design-document/14-webhook.md b/docs/design-document/14-webhook.md
@@ -166,7 +166,7 @@ Output params:
 | cloudEventIdGenerateMode | cloudEvent event object identification method, uuid or event id | string | N　| manufacturerEventId　|
 
 
-##### 通过manufacturer查询WebHookConfig列表
+##### Query WebHook config by manufacturer
 path: /webhook/queryWebHookConfigByManufacturer
 method: POST
 contentType： application/json
@@ -176,16 +176,18 @@ input params:
 | field | desc | type |　necessary | default　|
 | -- | -- | -- | -- | -- |
 | manufacturerName | manufacturer name | string | Y　| null　|
+| pageNum | page number of paging query | string | Y　| null　|
+| pageSize | page size of each page | string | Y　| null　|
 
 
 E.g:
 
 ```json
-
 {
-	"manufacturerName":"github"
+    "manufacturerName":"github",
+    "pageNum":1,
+    "pageSize":2
 }
-
 ```
 
 Output params:

diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/15-webhook.md b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/15-webhook.md
@@ -26,8 +26,8 @@ eventMesh.webHook.producer.connector=standalone
 ```java
    /**
     * 厂商调用的path。厂商事件调用地址、 [http or https ]://[域名 or IP 【厂商可以被调用】]:[端口]/webhook/[callbackPath]
-    * 比如：http://127.0.0.1:10504/webhook/test/event 需要把全完url填入厂商调用输入中
-    * callbackPath 是唯一
+    * 比如：http://127.0.0.1:10504/webhook/test/event 需要把完整url填入callbackPath中
+    * callbackPath 唯一
     * manufacturer callback path
     */
     private String callbackPath;
@@ -181,16 +181,18 @@ contentType： application/json
 | 字段 | 说明 | 类型 |　必须 | 默认值　|
 | -- | -- | -- | -- | -- |
 | manufacturerName | 厂商名 | string | 是　| null　|
+| pageNum | 分页查询中的页数 | string | 是　| null　|
+| pageSize | 每一页的结果数量 | string | 是　| null　|
 
 
 列子：
 
 ```json
-
 {
-	"manufacturerName":"github"
+    "manufacturerName":"github",
+    "pageNum":1,
+    "pageSize":2
 }
-
 ```