Chore: Update Swagger API docs (#608)

2020-03-11 16:19:13 +05:30
parent a5b1e2b650
commit 260e40831a
23 changed files with 1014 additions and 463 deletions
--- a/swagger/paths/widget/inboxes/create.yml
+++ b/swagger/paths/widget/inboxes/create.yml
@@ -0,0 +1,34 @@
+post:
+  tags:
+    - Widget
+  operationId: widgetInboxCreation
+  summary: Create a website inbox
+  description: You can create more than one website inbox in each account
+  parameters:
+    - name: data
+      in: body
+      required: true
+      schema:
+        type: object
+        properties:
+          website:
+            type: object
+            properties:
+              website_name:
+                type: string
+                description: The name of the inbox
+              website_url:
+                type: string
+                description: URL at which the widget will be loaded
+              widget_color:
+                type: string
+                description: A Hex-color string used to customize the widget
+  responses:
+    200:
+      description: Success
+      schema:
+        $ref: '#/definitions/inbox'
+    404:
+      description: Inbox not found
+    403:
+      description: Access denied
--- a/swagger/paths/widget/inboxes/update.yml
+++ b/swagger/paths/widget/inboxes/update.yml
@@ -0,0 +1,28 @@
+patch:
+  tags:
+    - Widget
+  operationId: widgetInboxUpdate
+  summary: Update a website inbox
+  description: Update widget color of an inbox
+  parameters:
+    - name: data
+      in: body
+      required: true
+      schema:
+        type: object
+        properties:
+          website:
+            type: object
+            properties:
+              widget_color:
+                type: string
+                description: A Hex-color string used to customize the widget
+  responses:
+    200:
+      description: Success
+      schema:
+        $ref: '#/definitions/inbox'
+    404:
+      description: Inbox not found
+    403:
+      description: Access denied