{ "swagger": "2.0", "info": { "description": "通知服务，提供邮件、短信、推送等多种通知渠道的管理和发送功能", "title": "Notification Service API", "contact": {}, "version": "1.0.0" }, "basePath": "/api/v1", "paths": { "/admin/announcements": { "post": { "security": [ { "bearerAuth": [] } ], "description": "创建新的公告，支持草稿/定时发布，可指定目标租户和角色 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "创建公告", "parameters": [ { "description": "创建公告请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.CreateAnnouncementRequest" } } ], "responses": { "201": { "description": "创建成功", "schema": { "$ref": "#/definitions/dto.AnnouncementDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/admin/announcements/{id}": { "put": { "security": [ { "bearerAuth": [] } ], "description": "编辑指定公告（仅在draft状态可编辑） 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "更新公告", "parameters": [ { "type": "string", "description": "公告ID", "name": "id", "in": "path", "required": true }, { "description": "更新公告请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.UpdateAnnouncementRequest" } } ], "responses": { "200": { "description": "更新成功", "schema": { "$ref": "#/definitions/dto.AnnouncementDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } }, "delete": { "security": [ { "bearerAuth": [] } ], "description": "删除指定公告（仅在draft状态可删除） 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "删除公告", "parameters": [ { "type": "string", "description": "公告ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_micro-services_notification-service_internal_handler_dto.SimpleResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/admin/announcements/{id}/publish": { "post": { "security": [ { "bearerAuth": [] } ], "description": "将公告从draft/scheduled状态发布为published，向目标用户推送通知 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "发布公告", "parameters": [ { "type": "string", "description": "公告ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "发布成功", "schema": { "$ref": "#/definitions/dto.AnnouncementDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/admin/announcements/{id}/unpublish": { "post": { "security": [ { "bearerAuth": [] } ], "description": "将已发布的公告撤回到草稿状态（unpublish） 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "撤回公告", "parameters": [ { "type": "string", "description": "公告ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "撤回成功", "schema": { "$ref": "#/definitions/dto.AnnouncementDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/admin/notifications/broadcast": { "post": { "security": [ { "bearerAuth": [] } ], "description": "向租户下所有用户或指定用户群发送通知消息，适用于系统维护通知、安全告警等场景 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "广播通知", "parameters": [ { "description": "广播通知请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.BroadcastNotificationRequest" } } ], "responses": { "200": { "description": "广播发送成功", "schema": { "$ref": "#/definitions/dto.BroadcastNotificationDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/admin/notifications/event-mappings": { "post": { "security": [ { "bearerAuth": [] } ], "description": "创建事件类型到通知模板的映射关系 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "创建事件映射", "parameters": [ { "description": "创建事件映射请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.CreateEventMappingRequest" } } ], "responses": { "201": { "description": "创建成功", "schema": { "$ref": "#/definitions/dto.EventMappingDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/admin/notifications/event-mappings/{id}": { "put": { "security": [ { "bearerAuth": [] } ], "description": "更新指定ID的事件映射配置 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "更新事件映射", "parameters": [ { "type": "string", "description": "事件映射ID", "name": "id", "in": "path", "required": true }, { "description": "更新事件映射请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.UpdateEventMappingRequest" } } ], "responses": { "200": { "description": "更新成功", "schema": { "$ref": "#/definitions/dto.EventMappingDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } }, "delete": { "security": [ { "bearerAuth": [] } ], "description": "删除指定ID的事件映射 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "删除事件映射", "parameters": [ { "type": "string", "description": "事件映射ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_micro-services_notification-service_internal_handler_dto.SimpleResponse" } } } } }, "/admin/notifications/global-variables": { "post": { "security": [ { "bearerAuth": [] } ], "description": "创建租户/应用级别的全局变量（如品牌名称、支持邮箱等） 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "创建全局变量", "parameters": [ { "description": "创建全局变量请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.CreateGlobalVariableRequest" } } ], "responses": { "201": { "description": "创建成功", "schema": { "$ref": "#/definitions/dto.GlobalVariableDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/admin/notifications/global-variables/{id}": { "put": { "security": [ { "bearerAuth": [] } ], "description": "更新指定ID的全局变量值 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "更新全局变量", "parameters": [ { "type": "string", "description": "全局变量ID", "name": "id", "in": "path", "required": true }, { "description": "更新全局变量请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.UpdateGlobalVariableRequest" } } ], "responses": { "200": { "description": "更新成功", "schema": { "$ref": "#/definitions/dto.GlobalVariableDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } }, "delete": { "security": [ { "bearerAuth": [] } ], "description": "删除指定ID的全局变量 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "删除全局变量", "parameters": [ { "type": "string", "description": "全局变量ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_micro-services_notification-service_internal_handler_dto.SimpleResponse" } } } } }, "/admin/notifications/platform-stats": { "get": { "security": [ { "bearerAuth": [] } ], "description": "获取平台所有租户的通知发送、阅读等聚合统计数据 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "获取平台级通知统计", "responses": { "200": { "description": "统计结果", "schema": { "$ref": "#/definitions/dto.NotificationStatsDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/admin/notifications/templates": { "post": { "security": [ { "bearerAuth": [] } ], "description": "创建一个新的通知模板，用于后续基于模板发送通知 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "创建通知模板", "parameters": [ { "description": "创建模板请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.CreateTemplateRequest" } } ], "responses": { "201": { "description": "创建成功", "schema": { "$ref": "#/definitions/dto.TemplateDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/admin/notifications/templates/{id}": { "put": { "security": [ { "bearerAuth": [] } ], "description": "更新指定ID的通知模板内容 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "更新通知模板", "parameters": [ { "type": "string", "description": "模板ID", "name": "id", "in": "path", "required": true }, { "description": "更新模板请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.UpdateTemplateRequest" } } ], "responses": { "200": { "description": "更新成功", "schema": { "$ref": "#/definitions/dto.TemplateDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } }, "delete": { "security": [ { "bearerAuth": [] } ], "description": "删除指定ID的通知模板 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "删除通知模板", "parameters": [ { "type": "string", "description": "模板ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_micro-services_notification-service_internal_handler_dto.SimpleResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/admin/notifications/templates/{id}/clone-to-locale": { "post": { "security": [ { "bearerAuth": [] } ], "description": "将指定模板复制到目标 locale，用于国际化支持 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "跨 locale 复制模板", "parameters": [ { "type": "string", "description": "模板ID", "name": "id", "in": "path", "required": true }, { "description": "跨locale复制请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.CloneTemplateToLocaleRequest" } } ], "responses": { "201": { "description": "复制成功", "schema": { "$ref": "#/definitions/dto.TemplateDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/announcements": { "get": { "security": [ { "bearerAuth": [] } ], "description": "分页查询公告列表，支持按状态过滤和关键词搜索 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "列出公告", "parameters": [ { "type": "integer", "default": 1, "description": "页码", "name": "page", "in": "query" }, { "type": "integer", "default": 20, "description": "每页条数", "name": "page_size", "in": "query" }, { "type": "string", "description": "状态过滤: draft/scheduled/published/expired", "name": "status", "in": "query" }, { "type": "string", "description": "搜索关键词", "name": "search", "in": "query" } ], "responses": { "200": { "description": "公告列表", "schema": { "$ref": "#/definitions/dto.AnnouncementListResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/announcements/{id}": { "get": { "security": [ { "bearerAuth": [] } ], "description": "获取指定公告的详细信息，包含阅读统计（views/dismissals） 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "获取公告详情", "parameters": [ { "type": "string", "description": "公告ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "公告详情", "schema": { "$ref": "#/definitions/dto.AnnouncementDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/announcements/{id}/stats": { "get": { "security": [ { "bearerAuth": [] } ], "description": "获取指定公告的阅读/送达统计数据 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "获取公告统计", "parameters": [ { "type": "string", "description": "公告ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "统计结果", "schema": { "$ref": "#/definitions/dto.AnnouncementStatsDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/internal/notification/export-user-data": { "post": { "description": "按租户和用户ID导出所有通知记录和偏好设置（GDPR合规数据导出） 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务 - 内部接口" ], "summary": "导出用户数据", "parameters": [ { "type": "string", "description": "租户ID", "name": "X-Tenant-ID", "in": "header", "required": true }, { "description": "导出数据请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.ExportUserDataRequest" } } ], "responses": { "200": { "description": "导出成功", "schema": { "$ref": "#/definitions/dto.DataResponse-dto_ExportUserDataResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/internal/notification/push/send": { "post": { "description": "向指定用户的设备发送 VAPID 签名的 Web Push 通知消息（内部API） 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务 - 内部接口" ], "summary": "内部推送通知发送", "parameters": [ { "type": "string", "description": "租户ID", "name": "X-Tenant-ID", "in": "header", "required": true }, { "description": "内部推送发送请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.InternalPushSendRequest" } } ], "responses": { "200": { "description": "发送成功", "schema": { "$ref": "#/definitions/dto.PushSendDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications": { "get": { "security": [ { "bearerAuth": [] } ], "description": "查询当前用户收到的通知列表，支持仅查询未读选项 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "获取通知列表", "parameters": [ { "type": "boolean", "description": "仅查询未读通知", "name": "unread_only", "in": "query" }, { "type": "integer", "description": "页码", "name": "page", "in": "query" }, { "type": "integer", "description": "每页条数", "name": "page_size", "in": "query" } ], "responses": { "200": { "description": "通知列表", "schema": { "$ref": "#/definitions/dto.NotificationListResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } }, "post": { "security": [ { "bearerAuth": [] } ], "description": "向指定用户发送一条通知消息，支持多种通知类型，记录发送状态并触发事件通知 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "发送通知", "parameters": [ { "description": "发送通知请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.SendNotificationRequest" } } ], "responses": { "201": { "description": "发送成功", "schema": { "$ref": "#/definitions/dto.NotificationDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications/event-mappings": { "get": { "security": [ { "bearerAuth": [] } ], "description": "获取当前租户的所有事件映射列表 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "列出事件映射", "responses": { "200": { "description": "事件映射列表", "schema": { "$ref": "#/definitions/dto.EventMappingListResponse" } } } } }, "/notifications/event-mappings/{id}": { "get": { "security": [ { "bearerAuth": [] } ], "description": "获取指定ID的事件映射详情 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "获取事件映射", "parameters": [ { "type": "string", "description": "事件映射ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/dto.EventMappingDetailResponse" } } } } }, "/notifications/global-variables": { "get": { "security": [ { "bearerAuth": [] } ], "description": "获取当前租户的所有全局变量列表 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "列出全局变量", "responses": { "200": { "description": "全局变量列表", "schema": { "$ref": "#/definitions/dto.GlobalVariableListResponse" } } } } }, "/notifications/global-variables/{id}": { "get": { "security": [ { "bearerAuth": [] } ], "description": "获取指定ID的全局变量详情 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "获取全局变量", "parameters": [ { "type": "string", "description": "全局变量ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/dto.GlobalVariableDetailResponse" } } } } }, "/notifications/preferences/{user_id}": { "get": { "security": [ { "bearerAuth": [] } ], "description": "获取指定用户的通知接收偏好，包括各渠道开关、免打扰时段等设置 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "获取通知偏好设置", "parameters": [ { "type": "string", "description": "用户ID", "name": "user_id", "in": "path", "required": true } ], "responses": { "200": { "description": "偏好设置", "schema": { "$ref": "#/definitions/dto.NotificationPreferencesDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } }, "put": { "security": [ { "bearerAuth": [] } ], "description": "更新指定用户的通知接收偏好，包括App内通知、邮件、短信、推送等渠道的开关控制 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "更新通知偏好设置", "parameters": [ { "type": "string", "description": "用户ID", "name": "user_id", "in": "path", "required": true }, { "description": "偏好设置", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.NotificationPreferencesRequest" } } ], "responses": { "200": { "description": "更新成功", "schema": { "$ref": "#/definitions/dto.NotificationPreferencesDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications/public/security-subscribe": { "post": { "description": "Trust Center: 公开订阅安全公告和合规更新（无认证） 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "合规管理 - Trust Center" ], "summary": "订阅安全公告", "parameters": [ { "description": "订阅请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.SecuritySubscribeRequest" } } ], "responses": { "200": { "description": "订阅成功", "schema": { "$ref": "#/definitions/dto.SecuritySubscribeDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications/public/security-unsubscribe": { "post": { "description": "Trust Center: 公开退订安全公告（无认证） 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "合规管理 - Trust Center" ], "summary": "退订安全公告", "parameters": [ { "description": "退订请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.SecurityUnsubscribeRequest" } } ], "responses": { "200": { "description": "退订成功", "schema": { "$ref": "#/definitions/dto.SecurityUnsubscribeDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications/read-all": { "put": { "security": [ { "bearerAuth": [] } ], "description": "将当前用户的所有未读通知一次性标记为已读状态 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "标记全部通知已读", "responses": { "200": { "description": "全部标记成功", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_micro-services_notification-service_internal_handler_dto.SimpleResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications/read-report": { "get": { "security": [ { "bearerAuth": [] } ], "description": "基于数据库中真实通知记录统计已读数、未读数、阅读率等运营指标 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "获取通知已读/未读报告", "responses": { "200": { "description": "已读报告", "schema": { "$ref": "#/definitions/dto.ReadReportDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications/send": { "post": { "security": [ { "bearerAuth": [] } ], "description": "与 /notifications 相同功能的兼容端点，向指定用户发送通知 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "发送通知（兼容端点）", "parameters": [ { "description": "发送通知请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.SendNotificationRequest" } } ], "responses": { "200": { "description": "发送成功", "schema": { "$ref": "#/definitions/dto.SendNotificationCompatDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications/send-batch": { "post": { "security": [ { "bearerAuth": [] } ], "description": "向多个用户同时发送相同的通知消息，适用于系统公告、运营活动等场景 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "批量发送通知", "parameters": [ { "description": "批量发送通知请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.BatchSendNotificationRequest" } } ], "responses": { "201": { "description": "批量发送成功", "schema": { "$ref": "#/definitions/dto.BatchSendNotificationDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications/send-from-template": { "post": { "security": [ { "bearerAuth": [] } ], "description": "使用指定模板向用户发送通知，支持模板变量替换 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "使用模板发送通知", "parameters": [ { "description": "使用模板发送请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.SendFromTemplateRequest" } } ], "responses": { "200": { "description": "发送成功", "schema": { "$ref": "#/definitions/dto.NotificationDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications/stats": { "get": { "security": [ { "bearerAuth": [] } ], "description": "获取当前租户的通知发送、送达、阅读等聚合统计数据 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "获取通知统计", "responses": { "200": { "description": "统计结果", "schema": { "$ref": "#/definitions/dto.NotificationStatsDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications/stream": { "get": { "security": [ { "bearerAuth": [] } ], "description": "通过Server-Sent Events实时推送通知，客户端需传入user_id查询参数进行订阅 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "text/event-stream" ], "tags": [ "通知服务" ], "summary": "SSE实时通知流", "parameters": [ { "type": "string", "description": "用户ID", "name": "user_id", "in": "query", "required": true } ], "responses": { "200": { "description": "SSE事件流" }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications/templates": { "get": { "security": [ { "bearerAuth": [] } ], "description": "获取所有通知模板列表，支持包含已停用模板的选项 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "列出通知模板", "parameters": [ { "type": "boolean", "description": "包含已停用模板", "name": "include_inactive", "in": "query" }, { "type": "string", "description": "通知类型过滤", "name": "type", "in": "query" }, { "type": "integer", "description": "页码（默认1）", "name": "page", "in": "query" }, { "type": "integer", "description": "每页条数（默认20）", "name": "page_size", "in": "query" } ], "responses": { "200": { "description": "模板列表", "schema": { "$ref": "#/definitions/dto.TemplateListResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications/templates/available": { "get": { "security": [ { "bearerAuth": [] } ], "description": "返回平台默认模板和本租户自定义模板的聚合列表 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "列出可用模板", "responses": { "200": { "description": "可用模板列表", "schema": { "$ref": "#/definitions/dto.AvailableTemplateListResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications/templates/{id}": { "get": { "security": [ { "bearerAuth": [] } ], "description": "获取指定ID的通知模板详情 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "获取通知模板", "parameters": [ { "type": "string", "description": "模板ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "模板详情", "schema": { "$ref": "#/definitions/dto.TemplateDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications/test": { "post": { "security": [ { "bearerAuth": [] } ], "description": "向指定渠道和目标发送一条测试通知，创建测试通知记录到数据库，用于验证通知服务配置是否正确 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "发送测试通知", "parameters": [ { "description": "测试通知请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.TestNotificationRequest" } } ], "responses": { "200": { "description": "测试通知已发送", "schema": { "$ref": "#/definitions/dto.TestNotificationDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications/trend": { "get": { "security": [ { "bearerAuth": [] } ], "description": "返回指定天数内每日通知发送量和已读量的趋势数据 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "获取通知趋势", "parameters": [ { "type": "integer", "description": "天数（默认30）", "name": "days", "in": "query" } ], "responses": { "200": { "description": "趋势数据", "schema": { "$ref": "#/definitions/dto.TrendResponse" } } } } }, "/notifications/unread": { "get": { "security": [ { "bearerAuth": [] } ], "description": "获取当前用户的所有未读通知列表 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "获取未读通知列表", "responses": { "200": { "description": "未读通知列表", "schema": { "$ref": "#/definitions/dto.NotificationListResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications/unread-count": { "get": { "security": [ { "bearerAuth": [] } ], "description": "获取当前用户的未读通知数量及最后通知时间 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "获取未读通知数量", "responses": { "200": { "description": "未读计数", "schema": { "$ref": "#/definitions/dto.UnreadCountDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications/{id}": { "delete": { "security": [ { "bearerAuth": [] } ], "description": "删除指定ID的通知记录（软验证用户ID匹配） 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "删除通知", "parameters": [ { "type": "string", "description": "通知ID", "name": "id", "in": "path", "required": true }, { "description": "删除通知请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.DeleteNotificationRequest" } } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/dto.DeleteNotificationDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications/{id}/read": { "put": { "security": [ { "bearerAuth": [] } ], "description": "将指定通知标记为已读状态，记录已读时间 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "标记通知已读", "parameters": [ { "type": "string", "description": "通知ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "标记成功", "schema": { "$ref": "#/definitions/dto.MarkReadDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/notifications/{id}/unread": { "put": { "security": [ { "bearerAuth": [] } ], "description": "将指定通知标记为未读状态 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "标记通知未读", "parameters": [ { "type": "string", "description": "通知ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "标记成功", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_micro-services_notification-service_internal_handler_dto.SimpleResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/push/subscriptions": { "get": { "security": [ { "bearerAuth": [] } ], "description": "查询当前用户的 Web Push 订阅列表 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "列出推送订阅", "responses": { "200": { "description": "订阅列表", "schema": { "$ref": "#/definitions/dto.PushSubscriptionListResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } }, "post": { "security": [ { "bearerAuth": [] } ], "description": "注册 Web Push 订阅（RFC 8030 VAPID），用于接收推送通知 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "注册 Web Push 推送订阅", "parameters": [ { "description": "推送订阅请求", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.PushSubscriptionRequest" } } ], "responses": { "201": { "description": "注册成功", "schema": { "$ref": "#/definitions/dto.PushSubscriptionDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } }, "delete": { "security": [ { "bearerAuth": [] } ], "description": "根据 endpoint 删除 Web Push 订阅 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "删除推送订阅", "parameters": [ { "type": "string", "description": "订阅端点URL", "name": "endpoint", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "401": { "description": "未认证", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "403": { "description": "权限不足", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "404": { "description": "资源未找到", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } }, "/push/vapid-public-key": { "get": { "description": "返回 Web Push VAPID 公钥，供前端注册 Push 订阅时使用 参考：CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知服务" ], "summary": "获取 VAPID 公钥", "responses": { "200": { "description": "VAPID 公钥", "schema": { "$ref": "#/definitions/dto.VapidPublicKeyDetailResponse" } }, "400": { "description": "请求参数错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } }, "500": { "description": "服务内部错误", "schema": { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.SimpleResponse" } } } } } }, "definitions": { "dto.AnnouncementDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.AnnouncementResponse" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "dto.AnnouncementListResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "items": { "description": "统一使用 items", "type": "array", "items": { "$ref": "#/definitions/dto.AnnouncementResponse" } }, "message": { "type": "string" }, "pagination": { "description": "分页信息（嵌套对象）", "allOf": [ { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.PageInfo" } ] }, "timestamp": { "type": "string" }, "total": { "description": "总条数（平铺，便于直接读取）", "type": "integer" } } }, "dto.AnnouncementResponse": { "description": "公告信息响应", "type": "object", "properties": { "content": { "type": "string", "example": "系统将于2026-05-15进行升级维护" }, "created_at": { "type": "string", "example": "2026-05-09T12:00:00Z" }, "dismissals": { "type": "integer", "example": 5 }, "expire_at": { "type": "string", "example": "2026-05-20T12:00:00Z" }, "id": { "type": "string", "example": "ann_abc123" }, "publish_at": { "type": "string", "example": "2026-05-10T12:00:00Z" }, "status": { "type": "string", "example": "published" }, "target_roles": { "type": "array", "items": { "type": "string" } }, "tenant_id": { "type": "string", "example": "tnt_xyz789" }, "title": { "type": "string", "example": "系统升级公告" }, "updated_at": { "type": "string", "example": "2026-05-09T12:00:00Z" }, "views": { "type": "integer", "example": 100 } } }, "dto.AnnouncementStatsDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.AnnouncementStatsResponse" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "dto.AnnouncementStatsResponse": { "description": "公告阅读统计", "type": "object", "properties": { "dismissals": { "type": "integer", "example": 5 }, "views": { "type": "integer", "example": 100 } } }, "dto.AvailableTemplateListResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "items": { "description": "统一使用 items", "type": "array", "items": { "$ref": "#/definitions/dto.AvailableTemplateResponse" } }, "message": { "type": "string" }, "pagination": { "description": "分页信息（嵌套对象）", "allOf": [ { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.PageInfo" } ] }, "timestamp": { "type": "string" }, "total": { "description": "总条数（平铺，便于直接读取）", "type": "integer" } } }, "dto.AvailableTemplateResponse": { "type": "object", "properties": { "channel": { "type": "string", "example": "in_app" }, "code": { "type": "string", "example": "welcome" }, "is_customized": { "type": "boolean", "example": false }, "locale": { "type": "string", "example": "zh-CN" }, "name": { "type": "string", "example": "欢迎通知" }, "source": { "description": "platform | tenant", "type": "string", "example": "platform" }, "status": { "type": "string", "example": "active" }, "title": { "type": "string" }, "variables": { "type": "array", "items": { "type": "string" } } } }, "dto.BatchSendNotificationDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.BatchSendNotificationResponse" }, "message": { "type": "string" } } }, "dto.BatchSendNotificationRequest": { "description": "批量发送通知请求参数", "type": "object", "required": [ "content", "title", "user_ids" ], "properties": { "content": { "description": "内容", "type": "string", "example": "您的账户已成功升级" }, "priority": { "description": "优先级", "type": "string", "example": "medium" }, "title": { "description": "标题", "type": "string", "example": "系统通知" }, "type": { "description": "类型", "type": "string", "example": "system" }, "user_ids": { "description": "用户ID列表", "type": "array", "items": { "type": "string" }, "example": [ "usr_001", "usr_002" ] } } }, "dto.BatchSendNotificationResponse": { "description": "批量发送通知结果", "type": "object", "properties": { "notification_ids": { "description": "通知ID列表", "type": "array", "items": { "type": "string" }, "example": [ "[\"ntf_001\"]" ] }, "sent_count": { "description": "发送数量", "type": "integer", "example": 5 } } }, "dto.BroadcastNotificationDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.BroadcastNotificationResponse" }, "message": { "type": "string" } } }, "dto.BroadcastNotificationRequest": { "description": "全租户广播通知的请求参数", "type": "object", "required": [ "content", "title" ], "properties": { "content": { "description": "内容", "type": "string", "example": "系统将于今晚22:00-23:00进行维护" }, "title": { "description": "标题", "type": "string", "example": "系统公告" }, "type": { "description": "类型", "type": "string", "example": "system" } } }, "dto.BroadcastNotificationResponse": { "description": "广播通知的响应结果", "type": "object", "properties": { "broadcast_id": { "description": "广播ID", "type": "string", "example": "broadcast-1234567890" }, "content": { "description": "内容", "type": "string", "example": "系统将于今晚22:00-23:00进行维护" }, "recipients": { "description": "接收人数", "type": "integer", "example": 100 }, "title": { "description": "标题", "type": "string", "example": "系统公告" }, "type": { "description": "类型", "type": "string", "example": "system" } } }, "dto.ChannelPref": { "description": "单个通知渠道的偏好", "type": "object", "properties": { "enabled": { "description": "启用", "type": "boolean", "example": true }, "quiet_hours_end": { "description": "免打扰结束", "type": "string", "example": "08:00" }, "quiet_hours_start": { "description": "免打扰开始", "type": "string", "example": "22:00" }, "types": { "description": "类型", "type": "array", "items": { "type": "string" }, "example": [ "[\"system\"", "\"user\"]" ] } } }, "dto.ChannelPrefResponse": { "description": "渠道偏好响应", "type": "object", "properties": { "enabled": { "description": "启用", "type": "boolean", "example": true }, "quiet_hours_end": { "description": "免打扰结束", "type": "string", "example": "08:00" }, "quiet_hours_start": { "description": "免打扰开始", "type": "string", "example": "22:00" }, "types": { "description": "类型", "type": "array", "items": { "type": "string" } } } }, "dto.CloneTemplateToLocaleRequest": { "type": "object", "required": [ "target_locale" ], "properties": { "content": { "type": "string" }, "target_locale": { "type": "string", "example": "en-US" }, "title": { "type": "string" } } }, "dto.CreateAnnouncementRequest": { "description": "创建公告的请求参数", "type": "object", "required": [ "content", "title" ], "properties": { "content": { "type": "string", "example": "系统将于2026-05-15进行升级维护" }, "expire_at": { "type": "string", "example": "2026-05-20T12:00:00Z" }, "publish_at": { "type": "string", "example": "2026-05-10T12:00:00Z" }, "target_roles": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string", "example": "系统升级公告" } } }, "dto.CreateEventMappingRequest": { "type": "object", "required": [ "event_type", "template_code" ], "properties": { "channel": { "type": "string" }, "event_type": { "type": "string" }, "priority": { "type": "string" }, "template_code": { "type": "string" } } }, "dto.CreateGlobalVariableRequest": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "dto.CreateTemplateRequest": { "description": "创建通知模板请求参数", "type": "object", "required": [ "code", "content", "name", "subject", "type" ], "properties": { "code": { "type": "string", "example": "welcome_notification" }, "content": { "type": "string", "example": "亲爱的{{user_name}}" }, "format": { "type": "string", "example": "simple" }, "name": { "type": "string", "example": "welcome_notification" }, "subject": { "type": "string", "example": "欢迎加入{{app_name}}" }, "type": { "type": "string", "example": "system" }, "variables": { "type": "array", "items": { "type": "string" }, "example": [ "[\"user_name\"]" ] } } }, "dto.DataResponse-dto_ExportUserDataResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.ExportUserDataResponse" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "dto.DeleteNotificationDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.DeleteNotificationResponse" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "dto.DeleteNotificationRequest": { "description": "删除通知请求参数", "type": "object", "required": [ "notification_id", "user_id" ], "properties": { "notification_id": { "description": "通知ID", "type": "string", "example": "ntf_abc123" }, "user_id": { "description": "用户ID", "type": "string", "example": "usr_abc123" } } }, "dto.DeleteNotificationResponse": { "description": "删除通知结果", "type": "object", "properties": { "deleted": { "description": "删除成功", "type": "boolean", "example": true }, "notification_id": { "description": "通知ID", "type": "string", "example": "ntf_abc123" } } }, "dto.EventMappingDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.EventMappingResponse" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "dto.EventMappingListResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "items": { "description": "统一使用 items", "type": "array", "items": { "$ref": "#/definitions/dto.EventMappingResponse" } }, "message": { "type": "string" }, "pagination": { "description": "分页信息（嵌套对象）", "allOf": [ { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.PageInfo" } ] }, "timestamp": { "type": "string" }, "total": { "description": "总条数（平铺，便于直接读取）", "type": "integer" } } }, "dto.EventMappingResponse": { "type": "object", "properties": { "app_id": { "type": "string" }, "channel": { "type": "string" }, "event_type": { "type": "string" }, "id": { "type": "string" }, "is_enabled": { "type": "boolean" }, "priority": { "type": "string" }, "template_code": { "type": "string" }, "tenant_id": { "type": "string" } } }, "dto.ExportUserDataRequest": { "type": "object", "required": [ "user_id" ], "properties": { "user_id": { "type": "string" } } }, "dto.ExportUserDataResponse": { "type": "object", "properties": { "notifications": { "type": "array", "items": { "$ref": "#/definitions/dto.NotificationResponse" } }, "preferences": { "$ref": "#/definitions/dto.NotificationPreferencesResponse" } } }, "dto.GlobalVariableDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.GlobalVariableResponse" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "dto.GlobalVariableListResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "items": { "description": "统一使用 items", "type": "array", "items": { "$ref": "#/definitions/dto.GlobalVariableResponse" } }, "message": { "type": "string" }, "pagination": { "description": "分页信息（嵌套对象）", "allOf": [ { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.PageInfo" } ] }, "timestamp": { "type": "string" }, "total": { "description": "总条数（平铺，便于直接读取）", "type": "integer" } } }, "dto.GlobalVariableResponse": { "type": "object", "properties": { "app_id": { "type": "string" }, "id": { "type": "string" }, "key": { "type": "string" }, "tenant_id": { "type": "string" }, "value": { "type": "string" } } }, "dto.InternalPushSendRequest": { "type": "object", "required": [ "body", "title" ], "properties": { "body": { "type": "string", "example": "Login from Beijing - Approve?" }, "data": { "type": "object", "additionalProperties": true }, "title": { "type": "string", "example": "New Login Attempt" }, "user_id": { "type": "string", "example": "user-001" } } }, "dto.MarkReadDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.MarkReadResponse" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "dto.MarkReadResponse": { "description": "标记已读结果", "type": "object", "properties": { "marked_count": { "description": "标记数量", "type": "integer", "example": 5 }, "success": { "description": "成功", "type": "boolean", "example": true } } }, "dto.NotificationDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.NotificationResponse" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "dto.NotificationListResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "items": { "description": "统一使用 items", "type": "array", "items": { "$ref": "#/definitions/dto.NotificationResponse" } }, "message": { "type": "string" }, "pagination": { "description": "分页信息（嵌套对象）", "allOf": [ { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.PageInfo" } ] }, "timestamp": { "type": "string" }, "total": { "description": "总条数（平铺，便于直接读取）", "type": "integer" } } }, "dto.NotificationPreferencesDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.NotificationPreferencesResponse" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "dto.NotificationPreferencesRequest": { "description": "更新通知偏好设置请求参数", "type": "object", "required": [ "user_id" ], "properties": { "channels": { "description": "渠道设置", "type": "object", "additionalProperties": { "$ref": "#/definitions/dto.ChannelPref" } }, "email_enabled": { "description": "邮件启用", "type": "boolean", "example": true }, "push_enabled": { "description": "推送启用", "type": "boolean", "example": true }, "sms_enabled": { "description": "短信启用", "type": "boolean", "example": false }, "user_id": { "description": "用户ID", "type": "string", "example": "usr_abc123" } } }, "dto.NotificationPreferencesResponse": { "description": "用户通知偏好设置", "type": "object", "properties": { "channels": { "description": "渠道设置", "type": "object", "additionalProperties": { "$ref": "#/definitions/dto.ChannelPrefResponse" } }, "email_enabled": { "description": "邮件启用", "type": "boolean", "example": true }, "push_enabled": { "description": "推送启用", "type": "boolean", "example": true }, "quiet_hours": { "description": "免打扰时段", "type": "object", "additionalProperties": { "$ref": "#/definitions/dto.ChannelPrefResponse" } }, "sms_enabled": { "description": "短信启用", "type": "boolean", "example": false }, "type_prefs": { "description": "通知类型偏好", "type": "object", "additionalProperties": { "$ref": "#/definitions/dto.ChannelPrefResponse" } }, "updated_at": { "description": "更新时间", "type": "string", "example": "2026-04-15T10:30:00Z" }, "user_id": { "description": "用户ID", "type": "string", "example": "usr_abc123" } } }, "dto.NotificationResponse": { "description": "通知信息响应", "type": "object", "properties": { "action_url": { "description": "操作链接", "type": "string", "example": "/security" }, "content": { "description": "内容", "type": "string", "example": "您的账户已成功升级" }, "created_at": { "description": "创建时间", "type": "string", "example": "2026-04-15T10:30:00Z" }, "event_type": { "type": "string", "example": "status.incident.created" }, "id": { "description": "通知ID", "type": "string", "example": "ntf_abc123" }, "is_read": { "description": "是否已读", "type": "boolean", "example": false }, "metadata": { "description": "元数据JSON", "type": "string", "example": "{\"ip\":\"1.2.3.4\"}" }, "priority": { "description": "优先级", "type": "string", "example": "medium" }, "read_at": { "description": "阅读时间", "type": "string", "example": "2026-04-15T11:00:00Z" }, "tenant_id": { "description": "租户ID", "type": "string", "example": "tnt_xyz789" }, "title": { "description": "标题", "type": "string", "example": "系统通知" }, "type": { "description": "类型", "type": "string", "example": "system" }, "user_id": { "description": "用户ID", "type": "string", "example": "usr_abc123" } } }, "dto.NotificationStatsDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.NotificationStatsResponse" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "dto.NotificationStatsResponse": { "description": "通知发送与阅读统计（notification 层不追踪投递状态，仅追踪已读/未读）", "type": "object", "properties": { "by_type": { "description": "按类型", "type": "object", "additionalProperties": { "type": "integer" } }, "read_rate": { "description": "阅读率", "type": "number", "example": 0.45 }, "total_read": { "description": "总阅读", "type": "integer", "example": 450 }, "total_sent": { "description": "总发送", "type": "integer", "example": 1000 } } }, "dto.PushSendDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.PushSendResponse" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "dto.PushSendResponse": { "type": "object", "properties": { "failed": { "type": "integer", "example": 0 }, "sent": { "type": "integer", "example": 3 }, "total": { "type": "integer", "example": 3 } } }, "dto.PushSubscriptionDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.PushSubscriptionResponse" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "dto.PushSubscriptionKeys": { "type": "object", "required": [ "auth", "p256dh" ], "properties": { "auth": { "type": "string", "example": "xK2s9..." }, "p256dh": { "type": "string", "example": "BP7S2s9..." } } }, "dto.PushSubscriptionListResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "items": { "description": "统一使用 items", "type": "array", "items": { "$ref": "#/definitions/dto.PushSubscriptionResponse" } }, "message": { "type": "string" }, "pagination": { "description": "分页信息（嵌套对象）", "allOf": [ { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.PageInfo" } ] }, "timestamp": { "type": "string" }, "total": { "description": "总条数（平铺，便于直接读取）", "type": "integer" } } }, "dto.PushSubscriptionRequest": { "type": "object", "required": [ "endpoint", "keys" ], "properties": { "device_name": { "type": "string", "example": "Chrome on Windows" }, "device_type": { "type": "string", "example": "web" }, "endpoint": { "type": "string", "example": "https://fcm.googleapis.com/fcm/send/..." }, "keys": { "$ref": "#/definitions/dto.PushSubscriptionKeys" }, "user_agent": { "type": "string" } } }, "dto.PushSubscriptionResponse": { "type": "object", "properties": { "created_at": { "type": "string", "example": "2026-05-12T12:00:00Z" }, "device_name": { "type": "string", "example": "Chrome on Windows" }, "device_type": { "type": "string", "example": "web" }, "endpoint": { "type": "string", "example": "https://fcm.googleapis.com/fcm/send/..." }, "id": { "type": "string", "example": "sub-abc123" } } }, "dto.ReadReportDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.ReadReportResponse" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "dto.ReadReportResponse": { "description": "通知已读/未读统计报告", "type": "object", "properties": { "read_count": { "description": "已读", "type": "integer", "example": 450 }, "read_rate": { "description": "阅读率", "type": "number", "example": 0.45 }, "tenant_id": { "description": "租户ID", "type": "string", "example": "tenant-001" }, "total_sent": { "description": "总发送", "type": "integer", "example": 1000 }, "unread_count": { "description": "未读", "type": "integer", "example": 550 } } }, "dto.SecuritySubscribeDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.SecuritySubscribeResponse" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "dto.SecuritySubscribeRequest": { "type": "object", "required": [ "email" ], "properties": { "company": { "type": "string", "example": "Example Inc" }, "email": { "type": "string", "example": "security@example.com" }, "topics": { "type": "array", "items": { "type": "string" }, "example": [ "[\"security_advisory\"", "\"compliance_update\"]" ] } } }, "dto.SecuritySubscribeResponse": { "type": "object", "properties": { "message": { "type": "string", "example": "确认邮件已发送" }, "status": { "type": "string", "example": "pending_confirmation" } } }, "dto.SecurityUnsubscribeDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.SecurityUnsubscribeResponse" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "dto.SecurityUnsubscribeRequest": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "example": "security@example.com" }, "token": { "type": "string", "example": "unsub_token_abc123" } } }, "dto.SecurityUnsubscribeResponse": { "type": "object", "properties": { "message": { "type": "string", "example": "已取消订阅" }, "status": { "type": "string", "example": "unsubscribed" } } }, "dto.SendFromTemplateRequest": { "description": "使用模板发送通知请求参数", "type": "object", "required": [ "template_id", "user_id", "variables" ], "properties": { "template_id": { "description": "模板ID", "type": "string", "example": "tpl_abc123" }, "user_id": { "description": "用户ID", "type": "string", "example": "usr_abc123" }, "variables": { "description": "变量", "type": "object", "additionalProperties": true } } }, "dto.SendNotificationCompatDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.SendNotificationCompatResponse" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "dto.SendNotificationCompatResponse": { "description": "发送通知的响应结果（兼容端点）", "type": "object", "properties": { "id": { "description": "通知ID", "type": "string", "example": "notif-1234567890" }, "status": { "description": "状态", "type": "string", "example": "sent" } } }, "dto.SendNotificationRequest": { "description": "发送通知的请求参数", "type": "object", "required": [ "content", "title", "user_id" ], "properties": { "aggregation_key": { "description": "聚合键（同key通知聚合为一条）", "type": "string", "example": "new_follower" }, "content": { "description": "内容", "type": "string", "example": "您的账户已成功升级" }, "metadata": { "description": "元数据", "type": "object", "additionalProperties": true }, "priority": { "description": "优先级", "type": "string", "example": "medium" }, "title": { "description": "标题", "type": "string", "example": "系统通知" }, "type": { "description": "类型", "type": "string", "example": "system" }, "user_id": { "description": "用户ID", "type": "string", "example": "usr_abc123" } } }, "dto.TemplateDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.TemplateResponse" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "dto.TemplateListResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "items": { "description": "统一使用 items", "type": "array", "items": { "$ref": "#/definitions/dto.TemplateResponse" } }, "message": { "type": "string" }, "pagination": { "description": "分页信息（嵌套对象）", "allOf": [ { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.PageInfo" } ] }, "timestamp": { "type": "string" }, "total": { "description": "总条数（平铺，便于直接读取）", "type": "integer" } } }, "dto.TemplateResponse": { "description": "通知模板信息", "type": "object", "properties": { "content": { "description": "内容", "type": "string", "example": "亲爱的{{user_name}}，欢迎加入{{app_name}}！" }, "created_at": { "description": "创建时间", "type": "string", "example": "2026-01-01T00:00:00Z" }, "name": { "description": "模板名称", "type": "string", "example": "welcome_notification" }, "subject": { "description": "主题", "type": "string", "example": "欢迎加入{{app_name}}" }, "template_id": { "description": "模板ID", "type": "string", "example": "tpl_abc123" }, "type": { "description": "类型", "type": "string", "example": "system" }, "variables": { "description": "变量", "type": "array", "items": { "type": "string" }, "example": [ "[\"user_name\"", "\"app_name\"]" ] } } }, "dto.TestNotificationDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.TestNotificationResponse" }, "message": { "type": "string" } } }, "dto.TestNotificationRequest": { "description": "发送测试通知的请求参数", "type": "object", "required": [ "channel", "target" ], "properties": { "channel": { "description": "渠道", "type": "string", "example": "email" }, "target": { "description": "目标", "type": "string", "example": "user@example.com" } } }, "dto.TestNotificationResponse": { "description": "测试通知发送结果", "type": "object", "properties": { "channel": { "description": "渠道", "type": "string", "example": "email" }, "status": { "description": "状态", "type": "string", "example": "sent" }, "target": { "description": "目标", "type": "string", "example": "user@example.com" }, "test_id": { "description": "测试ID", "type": "string", "example": "test-1234567890" } } }, "dto.TrendPoint": { "type": "object", "properties": { "date": { "type": "string", "example": "2026-06-04" }, "read": { "type": "integer", "example": 30 }, "sent": { "type": "integer", "example": 45 } } }, "dto.TrendResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "items": { "description": "统一使用 items", "type": "array", "items": { "$ref": "#/definitions/dto.TrendPoint" } }, "message": { "type": "string" }, "pagination": { "description": "分页信息（嵌套对象）", "allOf": [ { "$ref": "#/definitions/gitee_com_linmes_authms_base_dto.PageInfo" } ] }, "timestamp": { "type": "string" }, "total": { "description": "总条数（平铺，便于直接读取）", "type": "integer" } } }, "dto.UnreadCountDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.UnreadCountResponse" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "dto.UnreadCountResponse": { "description": "用户未读通知数量", "type": "object", "properties": { "last_notification_at": { "description": "最后通知", "type": "string", "example": "2026-04-15T10:30:00Z" }, "unread_count": { "description": "未读数", "type": "integer", "example": 5 }, "user_id": { "description": "用户ID", "type": "string", "example": "usr_abc123" } } }, "dto.UpdateAnnouncementRequest": { "description": "更新公告的请求参数（仅在draft状态可编辑）", "type": "object", "properties": { "content": { "type": "string" }, "expire_at": { "type": "string" }, "publish_at": { "type": "string" }, "target_roles": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" } } }, "dto.UpdateEventMappingRequest": { "type": "object", "properties": { "channel": { "type": "string" }, "is_enabled": { "type": "boolean" }, "priority": { "type": "string" }, "template_code": { "type": "string" } } }, "dto.UpdateGlobalVariableRequest": { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string" } } }, "dto.UpdateTemplateRequest": { "description": "更新通知模板的请求参数（所有字段可选）", "type": "object", "properties": { "content": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "subject": { "type": "string" }, "type": { "type": "string" }, "variables": { "type": "array", "items": { "type": "string" } } } }, "dto.VapidPublicKeyDetailResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.VapidPublicKeyResponse" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "dto.VapidPublicKeyResponse": { "description": "Web Push VAPID 公钥，前端注册 Push 订阅时使用", "type": "object", "properties": { "public_key": { "description": "VAPID 公钥", "type": "string", "example": "BEL5Oa..." } } }, "gitee_com_linmes_authms_base_dto.PageInfo": { "type": "object", "properties": { "has_next": { "description": "HasNext indicates whether there is a next page", "type": "boolean" }, "has_prev": { "description": "HasPrev indicates whether there is a previous page", "type": "boolean" }, "page": { "description": "Page is the current page number (1-based)", "type": "integer" }, "page_size": { "description": "PageSize is the number of items per page", "type": "integer" }, "total": { "description": "Total is the total number of items across all pages", "type": "integer" }, "total_pages": { "description": "TotalPages is the total number of pages", "type": "integer" } } }, "gitee_com_linmes_authms_base_dto.SimpleResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } }, "gitee_com_linmes_authms_micro-services_notification-service_internal_handler_dto.SimpleResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } } }, "securityDefinitions": { "bearerAuth": { "description": "Type \"Bearer\" followed by a space and JWT token.", "type": "apiKey", "name": "Authorization", "in": "header" } }, "tags": [ { "description": "通知管理：模板、发送、投递追踪", "name": "通知服务" }, { "description": "公告管理：创建、发布、订阅", "name": "公告服务" }, { "description": "公开信任中心：安全状态、合规证书、文档", "name": "Trust Center" } ] }