Skip to content

Document notification settings and snooze API endpoints#392

Closed
robzolkos wants to merge 6 commits intobasecamp:masterfrom
robzolkos:rzolkos/notification-settings-docs
Closed

Document notification settings and snooze API endpoints#392
robzolkos wants to merge 6 commits intobasecamp:masterfrom
robzolkos:rzolkos/notification-settings-docs

Conversation

@robzolkos
Copy link
Copy Markdown
Contributor

Summary

  • Add sections/notification_settings.md documenting three new API endpoints from basecamp/bc3#9931:
    • GET /my/notifications/settings.json — read notification preferences
    • PUT /my/notifications/settings.json — partial update with enum validation
    • PUT /my/notifications/snooze.json — snooze notifications for a duration
  • Add "Notification settings" to the README endpoint index

Copilot AI review requested due to automatic review settings March 12, 2026 19:29
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds documentation for the newly introduced “Notification settings” API surface, and links it from the main README so it’s discoverable alongside other endpoint docs.

Changes:

  • Added sections/notification_settings.md documenting notification settings read/update and snooze endpoints.
  • Added the new “Notification settings” entry to the README API endpoint index.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
sections/notification_settings.md New documentation for notification preferences endpoints, including request/response examples and parameter descriptions.
README.md Adds the “Notification settings” section to the API endpoints list for discoverability.

💡 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.

Comment thread sections/notification_settings.md Outdated
Copilot AI review requested due to automatic review settings March 22, 2026 20:29
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread sections/notification_settings.md Outdated
Comment thread sections/notification_settings.md
Copilot AI review requested due to automatic review settings March 22, 2026 20:40
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread sections/notification_settings.md
Comment thread sections/notification_settings.md
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@robzolkos
Copy link
Copy Markdown
Contributor Author

Closing this because the API docs have been repatriated into bc3 and are now included in basecamp/bc3#9931 instead.

@robzolkos robzolkos closed this Apr 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants