eddy/wwebjs-api
Watch
1
0
Fork
You've already forked wwebjs-api
 0
Code Issues 1 Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

feat(docs): implement comprehensive Chat and ChatId schemas for Swagger (#103)

Browse source 
* feat(docs): add ChatId schema definition to swagger.json

* feat(docs): integrate ChatId and define base of Chat schema.

* feat(docs): add response schema for chat listing
This commit is contained in:
Kauã Q. 2026-02-28 15:44:38 -04:00 • committed by GitHub
commit c6c746afbc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 150 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

113
swagger.json
View file

@ -1541,7 +1541,7 @@
"Client"
],
"summary": "Get all current chats",
"description": "",
"description": "Retrieve all chats for the given session ID.",
"parameters": [
{
"name": "sessionId",
@ -1556,7 +1556,14 @@
],
"responses": {
"200": {
"description": "OK"
"description": "Retrieved all chats.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetChatsResponse"
}
}
}
},
"403": {
"description": "Forbidden.",
@ -1610,7 +1617,7 @@
"Client"
],
"summary": "Get all current chats with optional search parameters",
"description": "",
"description": "Retrieve all chats for the given session ID with optional search parameters.",
"parameters": [
{
"name": "sessionId",
@ -1625,7 +1632,14 @@
],
"responses": {
"200": {
"description": "OK"
"description": "Retrieved all chats with search parameters.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetChatsResponse"
}
}
}
},
"403": {
"description": "Forbidden.",
@ -15071,6 +15085,97 @@
"xml": {
"name": "GetSessionsResponse"
}
},
"ChatId": {
"type": "object",
"properties": {
"server": {
"type": "string",
"example": "c.us | g.us"
},
"user": {
"type": "string",
"example": "1234567890"
},
"_serialized": {
"type": "string",
"example": "1234567890@c.us"
}
},
"xml": {
"name": "ChatId"
}
},
"Chat": {
"type": "object",
"properties": {
"id": {
"xml": {
"name": "chatid"
},
"$ref": "#/components/schemas/ChatId"
},
"name": {
"type": "string",
"example": "John Doe"
},
"isGroup": {
"type": "boolean",
"example": false
},
"unreadCount": {
"type": "number",
"example": 0
},
"timestamp": {
"type": "number",
"example": 1770140061
},
"archived": {
"type": "boolean",
"example": false
},
"pinned": {
"type": "boolean",
"example": false
},
"isMuted": {
"type": "boolean",
"example": false
},
"muteExpiration": {
"type": "number",
"example": 0
}
},
"xml": {
"name": "Chat"
}
},
"GetChatsResponse": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true
},
"chats": {
"type": "array",
"items": {
"xml": {
"name": "chat"
},
"$ref": "#/components/schemas/Chat"
}
},
"error": {
"type": "string",
"example": "error message if any"
}
},
"xml": {
"name": "GetChatsResponse"
}
}
},
"securitySchemes": {