Fix: Make swagger doc compliant to OpenAPI (#3394)

This fixes issues in the swagger.json file. The motivation to do so is to be able to generate API clients using https://openapi-generator.tech Doing so will require further changes to the api spec, but this seems like a good first step since it is now "valid" according to editor.swagger.io and openapi-generator validate.

Fixes #2806
This commit is contained in:
Jan-David
2021-11-17 14:25:15 +01:00
committed by GitHub
parent d227a56747
commit e500d1216b
55 changed files with 527 additions and 695 deletions

View File

@@ -16,7 +16,8 @@ post:
type: string
description: The name of the inbox
avatar:
type: file
type: string
format: binary
description: File for avatar image
channel:
type: object

View File

@@ -11,15 +11,18 @@ parameters:
required: true
schema:
type: object
required:
- inbox_id
- user_ids
properties:
inbox_id:
type: string
description: The ID of the inbox
required: true
user_ids:
user_ids:
type: array
items:
type: integer
description: IDs of users to be added to the inbox
required: true
responses:
200:
description: Success

View File

@@ -11,15 +11,18 @@ parameters:
required: true
schema:
type: object
required:
- inbox_id
- user_ids
properties:
inbox_id:
type: string
description: The ID of the inbox
required: true
user_ids:
user_ids:
type: array
items:
type: integer
description: IDs of users to be deleted from the inbox
required: true
responses:
200:
description: Success

View File

@@ -2,7 +2,7 @@ tags:
- Inbox
operationId: update-agents-in-inbox
summary: Update Agents in Inbox
description: All agents execept the one passed in params will be removed
description: All agents except the one passed in params will be removed
security:
- userApiKey: []
parameters:
@@ -11,15 +11,18 @@ parameters:
required: true
schema:
type: object
required:
- inbox_id
- user_ids
properties:
inbox_id:
type: string
description: The ID of the inbox
required: true
user_ids:
user_ids:
type: array
items:
type: integer
description: IDs of users to be added to the inbox
required: true
responses:
200:
description: Success

View File

@@ -16,10 +16,11 @@ post:
required: true
schema:
type: object
required:
- agent_bot
properties:
agent_bot:
type: number
required: true
description: 'Agent bot ID'
responses:
204:

View File

@@ -16,17 +16,18 @@ patch:
required: true
schema:
type: object
required:
- enable_auto_assignment
properties:
name:
type: string
description: The name of the inbox
enable_auto_assignment:
type: boolean
required: true
description: 'Enable Auto Assignment'
avatar:
type: file
required: false
type: string
format: binary
description: 'Image file for avatar'
channel:
type: object