feat(docs): implement comprehensive Chat and ChatId schemas for Swagger#103
Open
kaua-alves-queiros wants to merge 3 commits intoavoylenko:mainfrom
Open
feat(docs): implement comprehensive Chat and ChatId schemas for Swagger#103kaua-alves-queiros wants to merge 3 commits intoavoylenko:mainfrom
kaua-alves-queiros wants to merge 3 commits intoavoylenko:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📚 API Documentation Enhancement – Chat Schemas
This PR improves the API documentation by introducing explicit schemas for chat-related responses. As a result, the Swagger UI now accurately represents the data structures used in WhatsApp chat management.
✅ Changes
Schema Definitions
Added the following schemas to
swagger.jsandswagger.json:ChatIdChatGetChatsResponseController Integration
Updated
getChatsandgetChatsWithSearchinclientController.jsto leverage the new$refschema definitions.Documentation Clarity
Refined endpoint descriptions related to chat retrieval, clearly specifying session-based behavior.
🚀 Impact
Chatobject structure, including:unreadCountisGroupChatIdChatSchema