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

swagger/index.yml

@@ -1,47 +1,39 @@
-swagger: "2.0"
+openapi: '3.0.4'
 info:
-  description: This is the API documentation for Chatwoot server.
-  version: 1.0.0
   title: Chatwoot
-  termsOfService:	https://www.chatwoot.com/terms-of-service/
+  description: This is the API documentation for Chatwoot server.
+  version: 1.1.0
+  termsOfService: https://www.chatwoot.com/terms-of-service/
   contact:
     email: hello@chatwoot.com
   license:
     name: MIT License
     url: https://opensource.org/licenses/MIT
-host: app.chatwoot.com
-basePath: /
-schemes:
-  - https
-produces:
-- application/json; charset=utf-8
-consumes:
-- application/json; charset=utf-8
-securityDefinitions:
-  userApiKey:
-    type: apiKey
-    in: header
-    name: api_access_token
-    description: This token can be obtained by visiting the profile page or via rails console. Provides access to  endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.
-  agentBotApiKey:
-    type: apiKey
-    in: header
-    name: api_access_token
-    description: This token should be provided by system admin or obtained via rails console. This token can be used to build bot integrations and can only access limited apis.
-  platformAppApiKey:
-    type: apiKey
-    in: header
-    name: api_access_token
-    description: This token can be obtained by the system admin after creating a platformApp. This token should be used to provision agent bots, accounts, users and their roles.
-security:
-  - userApiKey: []
-
+servers:
+  - url: https://app.chatwoot.com/
 paths:
   $ref: ./paths/index.yml
-definitions:
-  $ref: ./definitions/index.yml
-parameters:
-  $ref: ./parameters/index.yml
+components:
+  schemas:
+    $ref: ./definitions/index.yml
+  parameters:
+    $ref: ./parameters/index.yml
+  securitySchemes:
+    userApiKey:
+      type: apiKey
+      in: header
+      name: api_access_token
+      description: This token can be obtained by visiting the profile page or via rails console. Provides access to  endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.
+    agentBotApiKey:
+      type: apiKey
+      in: header
+      name: api_access_token
+      description: This token should be provided by system admin or obtained via rails console. This token can be used to build bot integrations and can only access limited apis.
+    platformAppApiKey:
+      type: apiKey
+      in: header
+      name: api_access_token
+      description: This token can be obtained by the system admin after creating a platformApp. This token should be used to provision agent bots, accounts, users and their roles.
 
 x-tagGroups:
   - name: Platform
@@ -56,9 +48,6 @@ x-tagGroups:
       - Agents
       - Canned Responses
       - Contacts
-      - Contact Labels
-      - Conversation Assignment
-      - Conversation Labels
       - Conversations
       - Custom Attributes
       - Custom Filters