chore: Swagger documentation for public APIs (#2417)

This commit is contained in:
Sojan Jose
2021-06-16 00:14:09 +05:30
committed by GitHub
parent 2b9c93a1b3
commit af8223545e
22 changed files with 978 additions and 186 deletions

View File

@@ -0,0 +1,17 @@
type: object
properties:
id:
type: integer
description: Id of the contact
source_id:
type: string
description: The session identifier of the contact
name:
type: string
description: Name of the contact
email:
type: string
description: Email of the contact
pubsub_token:
type: string
description: The token to be used to connect to chatwoot websocket

View File

@@ -0,0 +1,14 @@
type: object
properties:
id:
type: integer
description: Id of the conversation
inbox_id:
type: string
description: The inbox id of the conversation
messages:
type: array
description: Messages in the conversation
contact:
type: object
description: The contact information associated to the conversation

View File

@@ -0,0 +1,36 @@
type: object
properties:
id:
type: string
description: Id of the message
content:
type: string
description: Text content of the message
message_type:
type: string
description: Denotes the message type
content_type:
type: string
description: Content type of the message
content_attributes:
type: string
description: Additional content attributes of the message
created_at:
type: string
description: Created at time stamp of the message
conversation_id:
type: string
description: Conversation Id of the message
attachments:
type: array
description: Attachments if any
sender:
type: object
description: Details of the sender

View File

@@ -19,8 +19,6 @@ properties:
enum: ['agent', 'administrator']
confirmed:
type: boolean
display_name:
type: string
accounts:
type: array
items: