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

swagger/paths/application/custom_attributes/create.yml

@@ -5,16 +5,22 @@ summary: Add a new custom attribute
 description: Add a new custom attribute to account
 security:
   - userApiKey: []
-parameters:
-  - name: data
-    in: body
-    required: true
-    schema:
-      $ref: '#/definitions/custom_attribute_create_update_payload'
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        $ref: '#/components/schemas/custom_attribute_create_update_payload'
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-       $ref: '#/definitions/custom_attribute'
-  403:
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/custom_attribute'
+  '403':
     description: Access denied
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

swagger/paths/application/custom_attributes/delete.yml

@@ -6,16 +6,25 @@ description: Remove a custom attribute from account
 security:
   - userApiKey: []
 parameters:
-  - $ref: '#/parameters/account_id'
+  - $ref: '#/components/parameters/account_id'
   - in: path
     name: id
-    type: integer
+    schema:
+      type: integer
     required: true
     description: The ID of the custom attribute to be deleted
 responses:
-  200:
+  '200':
     description: Success
-  404:
+  '404':
     description: Custom attribute 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/custom_attributes/index.yml

@@ -3,22 +3,29 @@ tags:
 operationId: get-account-custom-attribute
 summary: List all custom attributes in an account
 parameters:
-    - name: attribute_model
-      in: query
+  - name: attribute_model
+    in: query
+    schema:
       type: string
       enum: ['0', '1']
-      description: conversation_attribute(0)/contact_attribute(1)
-      required: true
+    description: conversation_attribute(0)/contact_attribute(1)
+    required: true
 description: Get details of custom attributes in an Account
 security:
   - userApiKey: []
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-        type: array
-        description: 'Array of all custom attributes'
-        items:
-          $ref: '#/definitions/custom_attribute'
-  403:
+    content:
+      application/json:
+        schema:
+          type: array
+          description: 'Array of all custom attributes'
+          items:
+            $ref: '#/components/schemas/custom_attribute'
+  '403':
     description: Access denied
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

swagger/paths/application/custom_attributes/show.yml

@@ -2,20 +2,33 @@ tags:
   - Custom Attributes
 operationId: get-details-of-a-single-custom-attribute
 summary: Get a custom attribute details
+security:
+  - userApiKey: []
 description: Get the details of a custom attribute in the account
 parameters:
-  - $ref: '#/parameters/account_id'
+  - $ref: '#/components/parameters/account_id'
   - in: path
     name: id
-    type: integer
+    schema:
+      type: integer
     required: true
     description: The ID of the custom attribute to be updated.
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-      $ref: '#/definitions/custom_attribute'
-  401:
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/custom_attribute'
+  '401':
     description: Unauthorized
-  404:
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '404':
     description: The given attribute ID does not exist in the account
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

swagger/paths/application/custom_attributes/update.yml

@@ -8,21 +8,33 @@ security:
 parameters:
   - in: path
     name: id
-    type: integer
+    schema:
+      type: integer
     required: true
     description: The ID of the custom attribute to be updated.
-  - name: data
-    in: body
-    required: true
-    schema:
-      $ref: '#/definitions/custom_attribute_create_update_payload'
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        $ref: '#/components/schemas/custom_attribute_create_update_payload'
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-        description: 'The updated custom attribute'
-        $ref: '#/definitions/custom_attribute'
-  404:
+    content:
+      application/json:
+        schema:
+          description: 'The updated custom attribute'
+          $ref: '#/components/schemas/custom_attribute'
+  '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'