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

swagger/paths/application/reports/conversation/account.yml

@@ -2,22 +2,33 @@ tags:
   - Reports
 operationId: get-account-conversation-metrics
 summary: Account Conversation Metrics
+security:
+  - userApiKey: []
 description: Get conversation metrics for Account
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-      type: object
-      description: 'Object of account conversation metrics'
-      properties:
-        open:
-          type: number
-        unattended:
-          type: number
-        unassigned:
-          type: number
-        
-  404:
+    content:
+      application/json:
+        schema:
+          type: object
+          description: 'Object of account conversation metrics'
+          properties:
+            open:
+              type: number
+            unattended:
+              type: number
+            unassigned:
+              type: number
+  '404':
     description: reports 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'

swagger/paths/application/reports/conversation/agent.yml

@@ -2,17 +2,28 @@ tags:
   - Reports
 operationId: get-agent-conversation-metrics
 summary: Agent Conversation Metrics
+security:
+  - userApiKey: []
 description: Get conversation metrics for Agent
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-      type: array
-      description: 'Array of agent based conversation metrics'
-      items:
-        $ref: '#/definitions/agent_conversation_metrics'
-        
-  404:
+    content:
+      application/json:
+        schema:
+          type: array
+          description: 'Array of agent based conversation metrics'
+          items:
+            $ref: '#/components/schemas/agent_conversation_metrics'
+  '404':
     description: reports 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'

swagger/paths/application/reports/index.yml

@@ -2,21 +2,33 @@ tags:
   - Reports
 operationId: list-all-conversation-statistics
 summary: Get Account reports
+security:
+  - userApiKey: []
 description: Get Account reports for a specific type, metric and date range
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-      type: array
-      description: 'Array of date based conversation statistics'
-      items:
-        type: object
-        properties:
-          value:
-            type: string
-          timestamp:
-            type: number
-  404:
+    content:
+      application/json:
+        schema:
+          type: array
+          description: 'Array of date based conversation statistics'
+          items:
+            type: object
+            properties:
+              value:
+                type: string
+              timestamp:
+                type: number
+  '404':
     description: reports 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'

swagger/paths/application/reports/summary.yml

@@ -2,14 +2,26 @@ tags:
   - Reports
 operationId: list-all-conversation-statistics-summary
 summary: Get Account reports summary
+security:
+  - userApiKey: []
 description: Get Account reports summary for a specific type and date range
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-      description: 'Object of summary metrics'
-      $ref: '#/definitions/account_summary'
-  404:
+    content:
+      application/json:
+        schema:
+          description: 'Object of summary metrics'
+          $ref: '#/components/schemas/account_summary'
+  '404':
     description: reports 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'