Skip to content

feat(api): document section_id and section_name on a user's topic preference #173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mikemilla merged 1 commit into from
Aug 18, 2026
Merged

feat(api): document section_id and section_name on a user's topic preference #173

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions src/courier/types/users/topic_preference.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,17 @@ class TopicPreference(BaseModel):
Whether the user has chosen specific delivery channels for this topic (listed in
custom_routing) rather than the topic's default routing.
"""

section_id: Optional[str] = None
"""The unique identifier of the section this topic belongs to.

Always present when listing a user's preferences; omitted by the single-topic
read when the topic has no resolvable section.
"""

section_name: Optional[str] = None
"""The display name of the section this topic belongs to.

Always present when listing a user's preferences; omitted by the single-topic
read when the topic has no resolvable section.
"""