chore(core): mark event and retries as deprecated for hooks api d…

…oc (#5048)
logto-io · Dec 4, 2023 · aa5bfdd · aa5bfdd
1 parent 3e92a20
commit aa5bfdd
Showing 1 changed file with 35 additions and 1 deletion.
diff --git a/packages/core/src/routes/hooks.openapi.json b/packages/core/src/routes/hooks.openapi.json
@@ -34,8 +34,20 @@
                   "name": {
                     "description": "The name of the hook."
                   },
+                  "event": {
+                    "deprecated": true,
+                    "description": "Use `events` instead."
+                  },
                   "events": {
                     "description": "An array of hook events."
+                  },
+                  "config": {
+                    "properties": {
+                      "retries": {
+                        "deprecated": true,
+                        "description": "Now the retry times is fixed to 3. Keep for backward compatibility."
+                      }
+                    }
                   }
                 }
               }
@@ -77,8 +89,20 @@
                   "name": {
                     "description": "The updated name of the hook."
                   },
+                  "event": {
+                    "deprecated": true,
+                    "description": "Use `events` instead."
+                  },
                   "events": {
                     "description": "An array of updated hook events."
+                  },
+                  "config": {
+                    "properties": {
+                      "retries": {
+                        "deprecated": true,
+                        "description": "Now the retry times is fixed to 3. Keep for backward compatibility."
+                      }
+                    }
                   }
                 }
               }
@@ -128,11 +152,21 @@
             "application/json": {
               "schema": {
                 "properties": {
+                  "event": {
+                    "deprecated": true,
+                    "description": "Use `events` instead."
+                  },
                   "events": {
                     "description": "An array of hook events for testing."
                   },
                   "config": {
-                    "description": "The hook configuration for testing."
+                    "description": "The hook configuration for testing.",
+                    "properties": {
+                      "retries": {
+                        "deprecated": true,
+                        "description": "Now the retry times is fixed to 3. Keep for backward compatibility."
+                      }
+                    }
                   }
                 }
               }