Fix: Make swagger doc compliant to OpenAPI (#3394)

This fixes issues in the swagger.json file. The motivation to do so is to be able to generate API clients using https://openapi-generator.tech Doing so will require further changes to the api spec, but this seems like a good first step since it is now "valid" according to editor.swagger.io and openapi-generator validate.

Fixes #2806

swagger/parameters/account_id.yml

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

swagger/parameters/agent_bot_id.yml

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

swagger/parameters/contact_sort.yml

@@ -1,15 +1,14 @@
 in: query
 name: sort
-schema:
-  type: string
-  enum:
-    - name
-    - email
-    - phone_number
-    - last_activity_at
-    - -name
-    - -email
-    - -phone_number
-    - -last_activity_at
+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,6 +1,5 @@
 in: path
 name: conversation_id
-schema:
-  type: integer
+type: integer
 required: true
 description: The numeric ID of the conversation

swagger/parameters/custom_filter_id.yml

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

swagger/parameters/hook_id.yml

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

swagger/parameters/inbox_id.yml

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

swagger/parameters/message_id.yml

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

swagger/parameters/page.yml

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

swagger/parameters/platform_user_id.yml

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

swagger/parameters/public/contact_identifier.yml

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

swagger/parameters/public/inbox_identifier.yml

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

swagger/parameters/report_metric.yml

@@ -1,7 +1,12 @@
 in: query
 name: metric
-schema:
-  type: string
-  enum: [conversations_count, incoming_messages_count, outgoing_messages_count, avg_first_response_time, avg_resolution_time, resolutions_count]
+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,7 +1,11 @@
 in: query
 name: report_type
-schema:
-  type: string
-  enum: [account,agent,inbox,label,team]
+type: string
+enum:
+  - account
+  - agent
+  - inbox
+  - label
+  - team
 required: true
-description: Type of report 
+description: Type of report

swagger/parameters/source_id.yml

@@ -1,2 +1,5 @@
+in: path
+name: source_id
+required: true
 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"
+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,6 +1,5 @@
 in: path
 name: id
-schema:
-  type: integer
+type: integer
 required: true
 description: The ID of the team to be updated