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

swagger/paths/application/canned_responses/create.yml

@@ -5,17 +5,23 @@ summary: Add a New Canned Response
 description: Add a new Canned Response to Account
 security:
   - userApiKey: []
-parameters:
-  - name: data
-    in: body
-    required: true
-    schema:
-      $ref: '#/definitions/canned_response_create_update_payload'
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        $ref: '#/components/schemas/canned_response_create_update_payload'
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-        description: 'Newly Created Canned Response'
-        $ref: '#/definitions/canned_response'
-  403:
+    content:
+      application/json:
+        schema:
+          description: 'Newly Created Canned Response'
+          $ref: '#/components/schemas/canned_response'
+  '403':
     description: Access denied
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

swagger/paths/application/canned_responses/delete.yml

@@ -8,13 +8,22 @@ security:
 parameters:
   - in: path
     name: id
-    type: integer
+    schema:
+      type: integer
     required: true
     description: The ID of the canned response to be deleted
 responses:
-  200:
+  '200':
     description: Success
-  404:
+  '404':
     description: Canned Response 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/canned_responses/index.yml

@@ -6,12 +6,18 @@ description: Get Details of Canned Responses in an Account
 security:
   - userApiKey: []
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-        type: array
-        description: 'Array of all canned responses'
-        items:
-          $ref: '#/definitions/canned_response'
-  403:
+    content:
+      application/json:
+        schema:
+          type: array
+          description: 'Array of all canned responses'
+          items:
+            $ref: '#/components/schemas/canned_response'
+  '403':
     description: Access denied
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

swagger/paths/application/canned_responses/update.yml

@@ -1,5 +1,5 @@
 tags:
-  - Canned Response
+  - Canned Responses
 operationId: update-canned-response-in-account
 summary: Update Canned Response in Account
 description: Update a Canned Response in Account
@@ -8,21 +8,33 @@ security:
 parameters:
   - in: path
     name: id
-    type: integer
+    schema:
+      type: integer
     required: true
     description: The ID of the canned response to be updated.
-  - name: data
-    in: body
-    required: true
-    schema:
-      $ref: '#/definitions/canned_response_create_update_payload'
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        $ref: '#/components/schemas/canned_response_create_update_payload'
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-        description: 'The updated canned response'
-        $ref: '#/definitions/canned_response'
-  404:
+    content:
+      application/json:
+        schema:
+          description: 'The updated canned response'
+          $ref: '#/components/schemas/canned_response'
+  '404':
     description: Agent 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'