feat(api): Add envelope endpoint and improve API documentation #67
+109
−28
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
- Add GET /envelope/{account_id}/{message_id} endpoint to retrieve message envelope (metadata)
- Add get_envelope_by_id method to ENVELOPE_INDEX_MANAGER for querying single envelope
- Move message_id from query parameter to path parameter for clearer API paths:
- /message-content/{account_id}/{message_id}
- /download-message/{account_id}/{message_id}
- /download-attachment/{account_id}/{message_id}
- /envelope/{account_id}/{message_id}
- Fix API documentation descriptions to be more accurate:
- search_messages: Now correctly describes search functionality
- get_thread_messages: Mentions thread_id requirement
- proxy endpoints: Fixed copy-paste errors from OAuth2 docs
- Update frontend API client to use new path-based URLs
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
GET /envelope/{account_id}/{message_id}endpoint to retrieve message envelope (metadata)message_idfrom query parameter to path parameter for clearer, more RESTful API pathsChanges
New Endpoint
GET /api/v1/envelope/{account_id}/{message_id}- Retrieves the envelope (metadata) of a specific messageAPI Path Improvements
/message-content/{account_id}?message_id=X/message-content/{account_id}/{message_id}/download-message/{account_id}?message_id=X/download-message/{account_id}/{message_id}/download-attachment/{account_id}?message_id=X&name=Y/download-attachment/{account_id}/{message_id}?name=YDocumentation Fixes
search_messages: Now correctly describes search functionality instead of "Lists messages"get_thread_messages: Mentionsthread_idrequirementTest plan
/api/v1/envelope/{account_id}/{message_id}returns correct envelope data/api/v1/message-content/{account_id}/{message_id}works with new path/api/v1/download-message/{account_id}/{message_id}works with new path/api/v1/download-attachment/{account_id}/{message_id}?name=Xworks with new path🤖 Generated with Claude Code