feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11374)

swagger/paths/application/inboxes/update.yml

@@ -3,58 +3,41 @@ patch:
     - Inboxes
   operationId: updateInbox
   summary: Update Inbox
-  description: Add avatar and disable auto assignment for an inbox
+  security:
+    - userApiKey: []
+  description: Update an existing inbox
   parameters:
-    - $ref: '#/parameters/account_id'
+    - $ref: '#/components/parameters/account_id'
     - name: id
       in: path
-      type: number
+      schema:
+        type: number
       description: ID of the inbox
       required: true
-    - name: data
-      in: body
-      required: true
-      schema:
-        type: object
-        required:
-          - enable_auto_assignment
-        properties:
-          name:
-            type: string
-            description: The name of the inbox
-          enable_auto_assignment:
-            type: boolean
-            description: 'Enable Auto Assignment'
-          avatar:
-            type: string
-            format: binary
-            description: 'Image file for avatar'
-          channel:
-            type: object
-            properties:
-              website_url:
-                type: string
-                description: URL at which the widget will be loaded
-              welcome_title:
-                type: string
-                description: Welcome title to be displayed on the widget
-              welcome_tagline:
-                type: string
-                description: Welcome tagline to be displayed on the widget
-              agent_away_message:
-                type: string
-                description: A message which will be sent if there is not agent available. This is not available if agentbot is connected
-              widget_color:
-                type: string
-                description: A Hex-color string used to customize the widget
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/inbox_update_payload'
   responses:
-    200:
+    '200':
       description: Success
-      schema:
-        type: object
-        description: 'Updated inbox object'
-        $ref: '#/definitions/inbox'
-    404:
+      content:
+        application/json:
+          schema:
+            type: object
+            description: 'Updated inbox object'
+            $ref: '#/components/schemas/inbox'
+    '404':
       description: Inbox not found
-    403:
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'
+    '403':
       description: Access denied
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'