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

swagger/paths/application/inboxes/inbox_members/create.yml

@@ -5,35 +5,51 @@ summary: Add a New Agent
 description: Add a new Agent to Inbox
 security:
   - userApiKey: []
-parameters:
-  - name: data
-    in: body
-    required: true
-    schema:
-      type: object
-      required:
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        type: object
+        required:
           - inbox_id
           - user_ids
-      properties:
-        inbox_id:
-          type: string
-          description: The ID of the inbox
-        user_ids:
-          type: array
-          items:
+        properties:
+          inbox_id:
             type: integer
-          description: IDs of users to be added to the inbox
+            description: The ID of the inbox
+            example: 1
+          user_ids:
+            type: array
+            items:
+              type: integer
+            description: IDs of users to be added to the inbox
+            example: [1]
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-        type: array
-        description: 'Array of all active agents'
-        items:
-          $ref: '#/definitions/agent'
-  404:
+    content:
+      application/json:
+        schema:
+          type: array
+          description: 'Array of all active agents'
+          items:
+            $ref: '#/components/schemas/agent'
+  '404':
     description: Inbox not found
-  403:
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '403':
     description: Access denied
-  422:
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '422':
     description: User must exist
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

swagger/paths/application/inboxes/inbox_members/delete.yml

@@ -5,30 +5,42 @@ summary: Remove an Agent from Inbox
 description: Remove an Agent from Inbox
 security:
   - userApiKey: []
-parameters:
-  - name: data
-    in: body
-    required: true
-    schema:
-      type: object
-      required:
-        - inbox_id
-        - user_ids
-      properties:
-        inbox_id:
-          type: string
-          description: The ID of the inbox
-        user_ids:
-          type: array
-          items:
-            type: integer
-          description: IDs of users to be deleted from the inbox
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        type: object
+        required:
+          - inbox_id
+          - user_ids
+        properties:
+          inbox_id:
+            type: string
+            description: The ID of the inbox
+          user_ids:
+            type: array
+            items:
+              type: integer
+            description: IDs of users to be deleted from the inbox
 responses:
-  200:
+  '200':
     description: Success
-  404:
+  '404':
     description: Inbox not found
-  403:
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '403':
     description: Access denied
-  422:
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '422':
     description: User must exist
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

swagger/paths/application/inboxes/inbox_members/show.yml

@@ -6,16 +6,26 @@ description: Get Details of Agents in an Inbox
 security:
   - userApiKey: []
 parameters:
-  - $ref: '#/parameters/inbox_id'
+  - $ref: '#/components/parameters/inbox_id'
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-        type: array
-        description: 'Array of all active agents'
-        items:
-          $ref: '#/definitions/agent'
-  404:
+    content:
+      application/json:
+        schema:
+          type: array
+          description: 'Array of all active agents'
+          items:
+            $ref: '#/components/schemas/agent'
+  '404':
     description: Inbox 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/inboxes/inbox_members/update.yml

@@ -5,35 +5,51 @@ summary: Update Agents in Inbox
 description: All agents except the one passed in params will be removed
 security:
   - userApiKey: []
-parameters:
-  - name: data
-    in: body
-    required: true
-    schema:
-      type: object
-      required:
-        - inbox_id
-        - user_ids
-      properties:
-        inbox_id:
-          type: string
-          description: The ID of the inbox
-        user_ids:
-          type: array
-          items:
-            type: integer
-          description: IDs of users to be added to the inbox
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        type: object
+        required:
+          - inbox_id
+          - user_ids
+        properties:
+          inbox_id:
+            type: string
+            description: The ID of the inbox
+            example: 1
+          user_ids:
+            type: array
+            items:
+              type: integer
+            description: IDs of users to be added to the inbox
+            example: [1]
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-        type: array
-        description: 'Array of all active agents'
-        items:
-          $ref: '#/definitions/agent'
-  404:
+    content:
+      application/json:
+        schema:
+          type: array
+          description: 'Array of all active agents'
+          items:
+            $ref: '#/components/schemas/agent'
+  '404':
     description: Inbox not found
-  403:
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '403':
     description: Access denied
-  422:
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '422':
     description: User must exist
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'