Add API documentation #7
Merged
Conversation
This file contains 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
penguineer
force-pushed
the
api-documentation
branch
from
2f4ad16
to
32605d0
Compare
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.
This pull request includes documentation updates and enhancements to the
ChatRequest,ChatResponse, andChatErrormodels. The most important changes involve adding detailed API documentation to theREADME.mdfile and enhancing the Java model classes with comprehensive JavaDoc comments.Documentation Updates:
README.md: Added detailed API documentation, including sections forChatRequest,ChatResponse,ChatError, and monitoring endpoints.Model Enhancements:
src/main/java/com/penguineering/hareairis/model/ChatError.java: Added JavaDoc comments to describe theChatErrorclass and its fields.src/main/java/com/penguineering/hareairis/model/ChatRequest.java: Added JavaDoc comments to describe theChatRequestclass and its fields.src/main/java/com/penguineering/hareairis/model/ChatResponse.java: Added JavaDoc comments to describe theChatResponseclass and its fields.