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

swagger/paths/application/automation_rule/create.yml

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

swagger/paths/application/automation_rule/delete.yml

@@ -8,7 +8,8 @@ security:
 parameters:
   - in: path
     name: id
-    type: integer
+    schema:
+      type: integer
     required: true
     description: The ID of the automation rule to be deleted
 responses:
@@ -16,5 +17,13 @@ responses:
     description: Success
   '403':
     description: Access denied
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
   '404':
     description: automation rule not found
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

swagger/paths/application/automation_rule/index.yml

@@ -3,18 +3,24 @@ tags:
 operationId: get-account-automation-rule
 summary: List all automation rules in an account
 parameters:
-  - $ref: '#/parameters/account_id'
-  - $ref: '#/parameters/page'
+  - $ref: '#/components/parameters/account_id'
+  - $ref: '#/components/parameters/page'
 description: Get details of automation rules in an Account
 security:
   - userApiKey: []
 responses:
   '200':
     description: Success
-    schema:
-      type: array
-      description: Array of all automation rules
-      items:
-        $ref: '#/definitions/automation_rule'
+    content:
+      application/json:
+        schema:
+          type: array
+          description: Array of all automation rules
+          items:
+            $ref: '#/components/schemas/automation_rule'
   '403':
     description: Access denied
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

swagger/paths/application/automation_rule/show.yml

@@ -3,18 +3,31 @@ tags:
 operationId: get-details-of-a-single-automation-rule
 summary: Get a automation rule details
 description: Get the details of a automation rule in the account
+security:
+  - userApiKey: []
 parameters:
   - in: path
     name: id
-    type: integer
+    schema:
+      type: integer
     required: true
     description: The ID of the automation rule to be updated.
 responses:
   '200':
     description: Success
-    schema:
-      $ref: '#/definitions/automation_rule'
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/automation_rule'
   '401':
     description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
   '404':
     description: The given rule ID does not exist in the account
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

swagger/paths/application/automation_rule/update.yml

@@ -8,20 +8,32 @@ security:
 parameters:
   - in: path
     name: id
-    type: integer
+    schema:
+      type: integer
     required: true
     description: The ID of the automation rule to be updated.
-  - name: data
-    in: body
-    required: true
-    schema:
-      $ref: '#/definitions/automation_rule_create_update_payload'
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        $ref: '#/components/schemas/automation_rule_create_update_payload'
 responses:
   '200':
     description: Success
-    schema:
-      $ref: '#/definitions/automation_rule'
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/automation_rule'
   '403':
     description: Access denied
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
   '404':
     description: Rule not found
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'