Add documentation: Define Request and Response Schemas for API Endpoints #10
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.
Define Request and Response Schemas for API Endpoints
Description
Many API endpoints currently lack defined request and response schemas in the OpenAPI specification. This makes it difficult for developers to understand the expected data format and can lead to integration errors. This document outlines the need to define these schemas for improved developer experience and reduced integration issues.
Priority
High
Rationale
Clear API schemas are crucial for developer understanding and ease of integration. Without them, developers must rely on example code or trial and error, which is inefficient and error-prone. Defined schemas provide a contract that developers can rely on, leading to faster development cycles and fewer errors.
Target Audience
Developers
API Reference
The following endpoints are missing schema definitions and require updates:
POST /messages/group/{accountId}/sendGET /messages/threads/{accountId}/get-all