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

swagger/paths/application/webhooks/create.yml

@@ -2,18 +2,27 @@ tags:
   - Webhooks
 operationId: create-a-webhook
 summary: Add a webhook
+security:
+  - userApiKey: []
 description: Add a webhook subscription to the account
 parameters:
-  - $ref: '#/parameters/account_id'
-  - name: data
-    in: body
-    required: true
-    schema:
-      $ref: '#/definitions/webhook_create_update_payload'
+  - $ref: '#/components/parameters/account_id'
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        $ref: '#/components/schemas/webhook_create_update_payload'
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-      $ref: '#/definitions/webhook'
-  401:
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/webhook'
+  '401':
     description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

swagger/paths/application/webhooks/delete.yml

@@ -2,11 +2,21 @@ tags:
   - Webhooks
 operationId: delete-a-webhook
 summary: Delete a webhook
+security:
+  - userApiKey: []
 description: Delete a webhook from the account
 responses:
-  200:
+  '200':
     description: Success
-  401:
+  '401':
     description: Unauthorized
-  404:
+    content:
+      application/json:
+        schema:
+          type: object
+  '404':
     description: The webhook does not exist in the account
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

swagger/paths/application/webhooks/index.yml

@@ -2,14 +2,22 @@ tags:
   - Webhooks
 operationId: list-all-webhooks
 summary: List all webhooks
-description:  List all webhooks in the account
+security:
+  - userApiKey: []
+description: List all webhooks in the account
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-      type: array
-      description: 'Array of webhook objects'
-      items:
-        $ref: '#/definitions/webhook'
-  401:
+    content:
+      application/json:
+        schema:
+          type: array
+          description: 'Array of webhook objects'
+          items:
+            $ref: '#/components/schemas/webhook'
+  '401':
     description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

swagger/paths/application/webhooks/update.yml

@@ -2,18 +2,27 @@ tags:
   - Webhooks
 operationId: update-a-webhook
 summary: Update a webhook object
+security:
+  - userApiKey: []
 description: Update a webhook object in the account
 parameters:
-  - $ref: '#/parameters/account_id'
-  - name: data
-    in: body
-    required: true
-    schema:
-      $ref: '#/definitions/webhook_create_update_payload'
+  - $ref: '#/components/parameters/account_id'
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        $ref: '#/components/schemas/webhook_create_update_payload'
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-      $ref: '#/definitions/webhook'
-  401:
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/webhook'
+  '401':
     description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'