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

swagger/paths/application/team_members/create.yml

@@ -5,31 +5,46 @@ summary: Add a New Agent
 description: Add a new Agent to Team
 security:
   - userApiKey: []
-parameters:
-  - name: data
-    in: body
-    required: true
-    schema:
-      type: object
-      required:
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        type: object
+        required:
           - user_ids
-      properties:
-        user_ids:
-          type: array
-          items:
-            type: integer
-          description: IDs of users to be added to the team
+        properties:
+          user_ids:
+            type: array
+            items:
+              type: integer
+            description: IDs of users to be added to the team
+            example: [1]
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-        type: array
-        description: 'Array of all active agents'
-        items:
-          $ref: '#/definitions/agent'
-  404:
-    description: Team not found
-  403:
+    content:
+      application/json:
+        schema:
+          type: array
+          description: 'Array of all active agents'
+          items:
+            $ref: '#/components/schemas/agent'
+  '403':
     description: Access denied
-  422:
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '404':
+    description: Team not found
+    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/team_members/delete.yml

@@ -5,27 +5,38 @@ summary: Remove an Agent from Team
 description: Remove an Agent from Team
 security:
   - userApiKey: []
-parameters:
-  - name: data
-    in: body
-    required: true
-    schema:
-      type: object
-      required:
-        - team_id
-        - user_ids
-      properties:
-        user_ids:
-          type: array
-          items:
-            type: integer
-          description: IDs of users to be deleted from the team
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        type: object
+        required:
+          - user_ids
+        properties:
+          user_ids:
+            type: array
+            items:
+              type: integer
+            description: IDs of users to be deleted from the team
 responses:
-  200:
+  '200':
     description: Success
-  404:
-    description: Team not found
-  403:
+  '403':
     description: Access denied
-  422:
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '404':
+    description: Team not found
+    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/team_members/index.yml

@@ -6,17 +6,27 @@ description: Get Details of Agents in an Team
 security:
   - userApiKey: []
 parameters:
-  - $ref: '#/parameters/account_id'
-  - $ref: '#/parameters/team_id'
+  - $ref: '#/components/parameters/account_id'
+  - $ref: '#/components/parameters/team_id'
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-        type: array
-        description: 'Array of all agents in the team'
-        items:
-          $ref: '#/definitions/agent'
-  404:
-    description: Inbox not found
-  403:
+    content:
+      application/json:
+        schema:
+          type: array
+          description: 'Array of all agents in the team'
+          items:
+            $ref: '#/components/schemas/agent'
+  '403':
     description: Access denied
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '404':
+    description: Team not found
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

swagger/paths/application/team_members/update.yml

@@ -5,31 +5,46 @@ summary: Update Agents in Team
 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:
-        - user_ids
-      properties:
-        user_ids:
-          type: array
-          items:
-            type: integer
-          description: IDs of users to be added to the team
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        type: object
+        required:
+          - user_ids
+        properties:
+          user_ids:
+            type: array
+            items:
+              type: integer
+            description: IDs of users to be added to the team
+            example: [1]
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-        type: array
-        description: 'Array of all agents in the team'
-        items:
-          $ref: '#/definitions/agent'
-  404:
-    description: Team not found
-  403:
+    content:
+      application/json:
+        schema:
+          type: array
+          description: 'Array of all agents in the team'
+          items:
+            $ref: '#/components/schemas/agent'
+  '403':
     description: Access denied
-  422:
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '404':
+    description: Team not found
+    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'