/announcements
分页查询公告列表，支持按状态过滤和关键词搜索 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。
Request Parameters
| Name | In | Type | Required | Default | Example | Constraints | Description |
|---|---|---|---|---|---|---|---|
page |
query |
integer |
No | 1 |
页码 | ||
page_size |
query |
integer |
No | 20 |
每页条数 | ||
status |
query |
string |
No | 状态过滤: draft/scheduled/published/expired | |||
search |
query |
string |
No | 搜索关键词 |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | 公告列表 | dto.AnnouncementListResponse |
| 400 | 请求参数错误 | gitee_com_linmes_authms_base_dto.SimpleResponse |
| 401 | 未认证 | gitee_com_linmes_authms_base_dto.SimpleResponse |
| 403 | 权限不足 | gitee_com_linmes_authms_base_dto.SimpleResponse |
| 404 | 资源未找到 | gitee_com_linmes_authms_base_dto.SimpleResponse |
| 500 | 服务内部错误 | gitee_com_linmes_authms_base_dto.SimpleResponse |
Referenced Schemas
dto.AnnouncementListResponse
| Field | Type | Required | Example | Constraints | Description |
|---|---|---|---|---|---|
code |
integer |
No | |||
items |
array of |
No | 统一使用 items | ||
message |
string |
No | |||
pagination |
object |
No | 分页信息（嵌套对象） | ||
timestamp |
string |
No | |||
total |
integer |
No | 总条数（平铺，便于直接读取） |
dto.AnnouncementResponse
公告信息响应
| Field | Type | Required | Example | Constraints | Description |
|---|---|---|---|---|---|
content |
string |
No | 系统将于2026-05-15进行升级维护 |
||
created_at |
string |
No | 2026-05-09T12:00:00Z |
||
dismissals |
integer |
No | 5 |
||
expire_at |
string |
No | 2026-05-20T12:00:00Z |
||
id |
string |
No | ann_abc123 |
||
publish_at |
string |
No | 2026-05-10T12:00:00Z |
||
status |
string |
No | published |
||
target_roles |
array of string |
No | |||
tenant_id |
string |
No | tnt_xyz789 |
||
title |
string |
No | 系统升级公告 |
||
updated_at |
string |
No | 2026-05-09T12:00:00Z |
||
views |
integer |
No | 100 |
gitee_com_linmes_authms_base_dto.PageInfo
| Field | Type | Required | Example | Constraints | Description |
|---|---|---|---|---|---|
has_next |
boolean |
No | HasNext indicates whether there is a next page | ||
has_prev |
boolean |
No | HasPrev indicates whether there is a previous page | ||
page |
integer |
No | Page is the current page number (1-based) | ||
page_size |
integer |
No | PageSize is the number of items per page | ||
total |
integer |
No | Total is the total number of items across all pages | ||
total_pages |
integer |
No | TotalPages is the total number of pages |
gitee_com_linmes_authms_base_dto.SimpleResponse
| Field | Type | Required | Example | Constraints | Description |
|---|---|---|---|---|---|
code |
integer |
No | |||
message |
string |
No | |||
timestamp |
string |
No |