chore: Swagger documentation for public APIs (#2417)
This commit is contained in:
17
swagger/definitions/resource/public/contact.yml
Normal file
17
swagger/definitions/resource/public/contact.yml
Normal 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
|
||||
14
swagger/definitions/resource/public/conversation.yml
Normal file
14
swagger/definitions/resource/public/conversation.yml
Normal 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
|
||||
36
swagger/definitions/resource/public/message.yml
Normal file
36
swagger/definitions/resource/public/message.yml
Normal 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
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -19,8 +19,6 @@ properties:
|
||||
enum: ['agent', 'administrator']
|
||||
confirmed:
|
||||
type: boolean
|
||||
display_name:
|
||||
type: string
|
||||
accounts:
|
||||
type: array
|
||||
items:
|
||||
|
||||
Reference in New Issue
Block a user