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

swagger/parameters/account_id.yml

@@ -1,5 +1,6 @@
 in: path
 name: account_id
-type: integer
+schema:
+  type: integer
 required: true
 description: The numeric ID of the account

swagger/parameters/agent_bot_id.yml

@@ -1,5 +1,6 @@
 in: path
 name: id
-type: integer
+schema:
+  type: integer
 required: true
 description: The ID of the agentbot to be updated

swagger/parameters/contact_sort.yml

@@ -1,14 +1,15 @@
 in: query
 name: sort
-type: string
-enum:
-  - name
-  - email
-  - phone_number
-  - last_activity_at
-  - -name
-  - -email
-  - -phone_number
-  - -last_activity_at
+schema:
+  type: string
+  enum:
+    - name
+    - email
+    - phone_number
+    - last_activity_at
+    - -name
+    - -email
+    - -phone_number
+    - -last_activity_at
 required: false
 description: The attribute by which list should be sorted

swagger/parameters/conversation_id.yml

@@ -1,5 +1,6 @@
 in: path
 name: conversation_id
-type: integer
+schema:
+  type: integer
 required: true
 description: The numeric ID of the conversation

swagger/parameters/conversation_uuid.yml

@@ -1,5 +1,6 @@
 in: path
 name: conversation_uuid
-type: integer
+schema:
+  type: integer
 required: true
 description: The uuid of the conversation

swagger/parameters/custom_filter_id.yml

@@ -1,5 +1,6 @@
 in: path
 name: custom_filter_id
-type: integer
+schema:
+  type: integer
 required: true
 description: The numeric ID of the custom filter

swagger/parameters/hook_id.yml

@@ -1,5 +1,6 @@
 in: path
 name: hook_id
-type: integer
+schema:
+  type: integer
 required: true
 description: The numeric ID of the integration hook

swagger/parameters/inbox_id.yml

@@ -1,5 +1,6 @@
 in: path
 name: inbox_id
-type: integer
+schema:
+  type: integer
 required: true
 description: The ID of the Inbox

swagger/parameters/message_id.yml

@@ -1,5 +1,6 @@
 in: path
 name: message_id
-type: integer
+schema:
+  type: integer
 required: true
 description: The numeric ID of the message

swagger/parameters/page.yml

@@ -1,6 +1,7 @@
 in: query
 name: page
-type: integer
-default: 1
+schema:
+  type: integer
+  default: 1
 required: false
 description: The page parameter

swagger/parameters/platform_user_id.yml

@@ -1,5 +1,6 @@
 in: path
 name: id
-type: integer
+schema:
+  type: integer
 required: true
 description: The numeric ID of the user on the platform

swagger/parameters/portal_id.yml

@@ -1,5 +1,6 @@
 in: path
-name: portal_id
-type: integer
+name: id
+schema:
+  type: string
 required: true
-description: The numeric ID of the portal
+description: The slug identifier of the portal

swagger/parameters/public/contact_identifier.yml

@@ -1,5 +1,6 @@
 in: path
 name: contact_identifier
-type: string
+schema:
+  type: string
 required: true
 description: The source id of contact obtained on contact create

swagger/parameters/public/inbox_identifier.yml

@@ -1,5 +1,6 @@
 in: path
 name: inbox_identifier
-type: string
+schema:
+  type: string
 required: true
 description: The identifier obtained from API inbox channel

swagger/parameters/report_metric.yml

@@ -1,12 +1,13 @@
 in: query
 name: metric
-type: string
-enum:
-  - conversations_count
-  - incoming_messages_count
-  - outgoing_messages_count
-  - avg_first_response_time
-  - avg_resolution_time
-  - resolutions_count
+schema:
+  type: string
+  enum:
+    - conversations_count
+    - incoming_messages_count
+    - outgoing_messages_count
+    - avg_first_response_time
+    - avg_resolution_time
+    - resolutions_count
 required: true
 description: The type of metric

swagger/parameters/report_type.yml

@@ -1,11 +1,12 @@
 in: query
 name: type
-type: string
-enum:
-  - account
-  - agent
-  - inbox
-  - label
-  - team
+schema:
+  type: string
+  enum:
+    - account
+    - agent
+    - inbox
+    - label
+    - team
 required: true
 description: Type of report

swagger/parameters/source_id.yml

@@ -1,5 +1,6 @@
 in: path
 name: source_id
 required: true
-type: string
+schema:
+  type: string
 description: "Id of the session for which the conversation is created.\n\n\n\n Source Ids can be obtained through contactable inboxes API or via generated.<br/><br/>Website: Chatwoot generated string which can be obtained from webhook events. <br/> Phone Channels(Twilio): Phone number in e164 format <br/> Email Channels: Contact Email address <br/> API Channel: Any Random String"

swagger/parameters/team_id.yml

@@ -1,5 +1,6 @@
 in: path
 name: team_id
-type: integer
+schema:
+  type: integer
 required: true
 description: The ID of the team to be updated

swagger/parameters/webhook_id.yml

@@ -1,5 +1,6 @@
 in: path
 name: webhook_id
-type: integer
+schema:
+  type: integer
 required: true
 description: The numeric ID of the webhook