docs(swagger): enhance label schemas and endpoint response documentation#113
Open
kaua-alves-queiros wants to merge 9 commits into
Open
docs(swagger): enhance label schemas and endpoint response documentation#113kaua-alves-queiros wants to merge 9 commits into
kaua-alves-queiros wants to merge 9 commits into
Conversation
…pdating definition names for labels, and documenting getChatLabels, getChatsByLabelId, and addOrRemoveLabels endpoints
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 – Label Schemas & Endpoint Refinement
This PR improves the API documentation by introducing explicit schemas for label-related responses and standardizing existing definitions. It ensures the Swagger UI accurately reflects the data structures used for label management and chat association.
✅ Changes
Schema Definitions
Added or updated the following schemas in
swagger.jsandswagger.json:GetLabelByIdResponsefor better naming consistency.GetAllLabelsResponseto align with the retrieval pattern.Controller Integration
Updated the Swagger annotations in
src/controllers/clientController.jsto leverage the new$refdefinitions for the following endpoints:GetChatLabelsResponse.GetChatsResponse.SuccessResponse.Documentation Clarity
Standardized naming conventions for all label-related schemas to ensure a predictable and professional API documentation experience.
🚀 Impact
Provides clear and consistent expectations for Label-related data structures, ensuring developers have precise information regarding response formats when managing WhatsApp labels.
Base Head:
c6c746a