Add API documentation for my notifications endpoint#395
Open
robzolkos wants to merge 2 commits intobasecamp:masterfrom
Open
Add API documentation for my notifications endpoint#395robzolkos wants to merge 2 commits intobasecamp:masterfrom
robzolkos wants to merge 2 commits intobasecamp:masterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new documentation section for the “My notifications” API (the endpoints backing Basecamp’s “Hey!” menu), and links it from the main README endpoint index.
Changes:
- Added
sections/my_notifications.mddocumentingGET /my/readings.jsonandPUT /my/unreads.json. - Added “My notifications” to the README endpoint index.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| sections/my_notifications.md | New endpoint documentation for listing notifications and marking them read, including example payloads/cURL. |
| README.md | Adds “My notifications” to the API endpoint index. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
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.
Summary
GET /my/readings.jsonendpoint as "My notifications" — the API behind the Hey! menuPUT /my/unreads.jsonendpoint for marking notifications as read