akadmin/chatwoot
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

update user profile payload for developer docs

Browse Source
This commit is contained in:
Tanmay Deep Sharma
2025-05-20 00:49:24 +07:00
parent 2b043e5460
commit 2187a3e566
4 changed files with 170 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
developer-docs/docs.json
+1 -1
View File
@@ -16,7 +16,7 @@
"tabs": [
{
"tab": "API Documentation",
"openapi": "https://raw.githubusercontent.com/chatwoot/chatwoot/ac94e34c723731ef7f9caf839c2616bd96ef89c1/swagger/swagger.json"
"openapi": "https://raw.githubusercontent.com/chatwoot/chatwoot/2b043e54604b70715a9e7d0a9a7836763174a126/swagger/swagger.json"
}
]
},
swagger/definitions/resource/user.yml
+62 -12
View File
@@ -2,27 +2,77 @@ type: object
properties:
id:
type: number
uid:
type: string
name:
type: string
available_name:
type: string
display_name:
type: string
email:
access_token:
type: string
account_id:
type: number
available_name:
type: string
avatar_url:
type: string
confirmed:
type: boolean
display_name:
type: string
nullable: true
message_signature:
type: string
nullable: true
email:
type: string
hmac_identifier:
type: string
inviter_id:
type: number
name:
type: string
provider:
type: string
pubsub_token:
type: string
role:
type: string
enum: ['agent', 'administrator']
confirmed:
type: boolean
ui_settings:
type: object
uid:
type: string
type:
type: string
nullable: true
custom_attributes:
type: object
description: Available for users who are created through platform APIs and has custom attributes associated.
accounts:
type: array
items:
$ref: '#/components/schemas/account'
type: object
properties:
id:
type: number
name:
type: string
status:
type: string
active_at:
type: string
format: date-time
role:
type: string
enum: ['administrator', 'agent']
permissions:
type: array
items:
type: string
availability:
type: string
availability_status:
type: string
auto_offline:
type: boolean
custom_role_id:
type: number
nullable: true
custom_role:
type: object
nullable: true
swagger/paths/application/integrations/apps/show.yml
+7 -4
View File
@@ -11,10 +11,13 @@ responses:
content:
application/json:
schema:
type: array
description: 'Array of Integration apps'
items:
$ref: '#/components/schemas/integrations_app'
type: object
properties:
payload:
type: array
description: 'Array of Integration apps'
items:
$ref: '#/components/schemas/integrations_app'
'401':
description: Unauthorized
content:
swagger/swagger.json
+100 -20
View File
@@ -6058,10 +6058,15 @@
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "Array of Integration apps",
"items": {
"$ref": "#/components/schemas/integrations_app"
"type": "object",
"properties": {
"payload": {
"type": "array",
"description": "Array of Integration apps",
"items": {
"$ref": "#/components/schemas/integrations_app"
}
}
}
}
}
@@ -8485,24 +8490,47 @@
"id": {
"type": "number"
},
"uid": {
"type": "string"
},
"name": {
"type": "string"
},
"available_name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"email": {
"access_token": {
"type": "string"
},
"account_id": {
"type": "number"
},
"available_name": {
"type": "string"
},
"avatar_url": {
"type": "string"
},
"confirmed": {
"type": "boolean"
},
"display_name": {
"type": "string",
"nullable": true
},
"message_signature": {
"type": "string",
"nullable": true
},
"email": {
"type": "string"
},
"hmac_identifier": {
"type": "string"
},
"inviter_id": {
"type": "number"
},
"name": {
"type": "string"
},
"provider": {
"type": "string"
},
"pubsub_token": {
"type": "string"
},
"role": {
"type": "string",
"enum": [
@@ -8510,8 +8538,15 @@
"administrator"
]
},
"confirmed": {
"type": "boolean"
"ui_settings": {
"type": "object"
},
"uid": {
"type": "string"
},
"type": {
"type": "string",
"nullable": true
},
"custom_attributes": {
"type": "object",
@@ -8520,7 +8555,52 @@
"accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/account"
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"active_at": {
"type": "string",
"format": "date-time"
},
"role": {
"type": "string",
"enum": [
"administrator",
"agent"
]
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
},
"availability": {
"type": "string"
},
"availability_status": {
"type": "string"
},
"auto_offline": {
"type": "boolean"
},
"custom_role_id": {
"type": "number",
"nullable": true
},
"custom_role": {
"type": "object",
"nullable": true
}
}
}
}
}