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

This commit is contained in:
Daniel Jimenez
2025-05-22 19:26:44 +12:00
committed by GitHub
parent 8697a30dc5
commit 4b417ce9e7
189 changed files with 10098 additions and 5847 deletions

View File

@@ -5,39 +5,23 @@ summary: Add a New Agent
description: Add a new Agent to Account
security:
- userApiKey: []
parameters:
- name: data
in: body
required: true
schema:
type: object
required:
- name
- email
- role
properties:
name:
type: string
description: Full Name of the agent
email:
type: string
description: Email of the Agent
role:
type: string
enum: ['agent', 'administrator']
description: Whether its administrator or agent
availability_status:
type: string
enum: ['available', 'busy', 'offline']
description: The availability setting of the agent.
auto_offline:
type: boolean
description: Whether the availability status of agent is configured to go offline automatically when away.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/agent_create_payload'
responses:
200:
'200':
description: Success
schema:
description: 'Newly Created Agent'
$ref: '#/definitions/agent'
403:
content:
application/json:
schema:
description: 'Newly Created Agent'
$ref: '#/components/schemas/agent'
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'