docs: Add documentation for integration APIs (#2300)

2021-05-20 20:46:45 +05:30
parent c681e8a01b
commit 46356d0bf9
23 changed files with 421 additions and 22 deletions
--- a/swagger/definitions/resource/integrations/app.yml
+++ b/swagger/definitions/resource/integrations/app.yml
@@ -0,0 +1,23 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the integration
+  name:
+    type: string
+    description: The name of the integration
+  description:
+    type: string
+    description: The description about the team
+  hook_type:
+    type: string
+    description: Whether the integration is an account or inbox integration
+  enabled:
+    type: boolean
+    description: Whether the integration is enabled for the account
+  allow_multiple_hooks:
+    type: boolean
+    description: Whether multiple hooks can be created for the integration
+  hooks:
+    type: array
+    description: If there are any hooks created for this integration