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

swagger/definitions/index.yml

@@ -1,13 +1,11 @@
-##  ---------- ERRORS ------------- ##
+## ---------- ERRORS -------------- ##
 ## -------------------------------- ##
 bad_request_error:
   $ref: ./error/bad_request.yml
 request_error:
   $ref: ./error/request.yml
 
-
-
-##  ---------- RESOURCE ------------- ##
+## ---------- RESOURCE ------------ ##
 ## -------------------------------- ##
 
 generic_id:
@@ -24,10 +22,6 @@ category:
   $ref: ./resource/category.yml
 article:
   $ref: ./resource/article.yml
-category:
-  $ref: ./resource/category.yml
-article:
-  $ref: ./resource/article.yml
 contact:
   $ref: ./resource/contact.yml
 conversation:
@@ -52,6 +46,8 @@ webhook:
   $ref: ./resource/webhook.yml
 account:
   $ref: ./resource/account.yml
+account_user:
+  $ref: ./resource/account_user.yml
 platform_account:
   $ref: ./resource/platform_account.yml
 team:
@@ -71,13 +67,18 @@ public_message:
 public_inbox:
   $ref: ./resource/public/inbox.yml
 
-
-##  ---------- REQUEST------------- ##
+## ---------- REQUEST ------------- ##
 ## -------------------------------- ##
 
 account_create_update_payload:
   $ref: ./request/account/create_update_payload.yml
 
+account_user_create_update_payload:
+  $ref: ./request/account_user/create_update_payload.yml
+
+platform_agent_bot_create_update_payload:
+  $ref: ./request/platform/agent_bot/create_update_payload.yml
+
 agent_bot_create_update_payload:
   $ref: ./request/agent_bot/create_update_payload.yml
 
@@ -89,21 +90,36 @@ canned_response_create_update_payload:
 
 custom_attribute_create_update_payload:
   $ref: ./request/custom_attribute/create_update_payload.yml
-## contact
-contact_create:
-  $ref: ./request/contact/create.yml
-contact_update:
-  $ref: ./request/contact/update.yml
 
-## conversation
-conversation_message_create:
-  $ref: ./request/conversation/create_message.yml
+## Agent
+agent_create_payload:
+  $ref: ./request/agent/create_payload.yml
+agent_update_payload:
+  $ref: ./request/agent/update_payload.yml
 
-# Team request Payload
+## Contact
+contact_create_payload:
+  $ref: ./request/contact/create_payload.yml
+contact_update_payload:
+  $ref: ./request/contact/update_payload.yml
+
+## Conversation
+conversation_create_payload:
+  $ref: ./request/conversation/create_payload.yml
+conversation_message_create_payload:
+  $ref: ./request/conversation/create_message_payload.yml
+
+# Inbox
+inbox_create_payload:
+  $ref: ./request/inbox/create_payload.yml
+inbox_update_payload:
+  $ref: ./request/inbox/update_payload.yml
+
+# Team
 team_create_update_payload:
   $ref: ./request/team/create_update_payload.yml
 
-# Custom Filter request Payload
+# Custom Filter
 custom_filter_create_update_payload:
   $ref: ./request/custom_filter/create_update_payload.yml
 
@@ -128,7 +144,6 @@ category_create_update_payload:
 article_create_update_payload:
   $ref: ./request/portal/article_create_update_payload.yml
 
-
 ## public requests
 public_contact_create_update_payload:
   $ref: ./request/public/contact/create_update_payload.yml
@@ -141,37 +156,37 @@ public_message_update_payload:
 public_conversation_create_payload:
   $ref: ./request/public/conversation/create_payload.yml
 
-##  ---------- RESPONSE ------------- ##
+## ---------- RESPONSE ------------ ##
 ## -------------------------------- ##
 
-## contact
+## Contact
 extended_contact:
   allOf:
-    - $ref: '#/definitions/contact'
+    - $ref: '#/components/schemas/contact'
     - $ref: ./resource/extension/contact/show.yml
 contact_base:
   allOf:
-    - $ref: '#/definitions/generic_id'
-    - $ref: '#/definitions/contact'
+    - $ref: '#/components/schemas/generic_id'
+    - $ref: '#/components/schemas/contact'
 contact_list:
   type: array
   description: 'array of contacts'
   items:
     allOf:
-      - $ref: '#/definitions/generic_id'
-      - $ref: '#/definitions/contact'
+      - $ref: '#/components/schemas/generic_id'
+      - $ref: '#/components/schemas/contact'
 contact_conversations:
   type: array
   description: 'array of conversations'
   items:
     allOf:
-      - $ref: '#/definitions/conversation'
+      - $ref: '#/components/schemas/conversation'
       - $ref: ./resource/extension/contact/conversation.yml
       - $ref: ./resource/extension/conversation/with_display_id.yml
 contact_labels:
   $ref: ./resource/extension/contact/labels.yml
 
-## conversation
+## Conversation
 conversation_list:
   $ref: ./resource/extension/conversation/list.yml
 conversation_show:
@@ -181,8 +196,7 @@ conversation_status_toggle:
 conversation_labels:
   $ref: ./resource/extension/conversation/labels.yml
 
-
-## report
+## Report
 account_summary:
   $ref: './resource/reports/summary.yml'
 agent_conversation_metrics: