Backend ai conversation history #1546
Merged
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds Swagger/OpenAPI documentation decorators to AI conversation history response objects to improve API documentation.
Changes:
- Added
@ApiPropertydecorators with descriptions toAiChatMessageRO,UserAiChatRO, andUserAiChatWithMessagesROclasses - Imported
ApiPropertyfrom@nestjs/swaggerto enable Swagger documentation
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @ApiProperty({ description: 'Message content' }) | ||
| message: string; | ||
|
|
||
| @ApiProperty({ enum: MessageRole, description: 'Role of the message sender (user or ai)' }) |
There was a problem hiding this comment.
The description mentions 'user or ai' but the MessageRole enum actually has three possible values: 'user', 'ai', and 'system'. The description should include all possible values to accurately document the API.
Suggested change
| @ApiProperty({ enum: MessageRole, description: 'Role of the message sender (user or ai)' }) | |
| @ApiProperty({ enum: MessageRole, description: 'Role of the message sender (user, ai, or system)' }) |
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.
No description provided.