feat: add admin announcements management and API documentation#82
Merged
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
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
Add a site announcement system for signed-in users and admin management.
Admins can create, edit, enable/disable, delete, prioritize, pin, and classify Markdown announcements. Signed-in users see active announcements in a grouped dialog with sorting by default order, type, or time. Announcement state is persisted per user and announcement version: closing an announcement marks the current version as read, while “today do not show” suppresses it only until the next day.
Change type
Affected areas
Verification
cd backend && go test ./internal/application/announcement/... ./internal/infra/persistence/postgres/announcement/... ./internal/infra/persistence/modelscd backend && make swaggercd frontend && pnpm lintcd frontend && pnpm buildScreenshots, API examples, or logs
UI changes include the admin announcement management page and the signed-in user announcement dialog.
New/updated API endpoints:
GET /api/v1/announcementsPOST /api/v1/announcements/{id}/dismiss-todayPOST /api/v1/announcements/{id}/closeGET /api/v1/admin/announcementsPOST /api/v1/admin/announcementsPATCH /api/v1/admin/announcements/{id}DELETE /api/v1/admin/announcements/{id}Configuration, migration, and compatibility notes
Adds announcement persistence tables and fields through the existing startup migration path:
system_announcementsannouncement_user_statestype,pinneddismissed_until,closed_atAnnouncement user state is versioned by
announcement_updated_at, so updated announcements are shown again even if a previous version was closed.Swagger docs were regenerated.
Documentation
Security and privacy
Checklist
.pycfiles,.envfiles, and local storage data are not committed.