优化

2026-08-12 18:23:57 +08:00
parent bac46a0f54
commit ae40d3f173
14 changed files with 339 additions and 9 deletions
@@ -0,0 +1,113 @@
+openapi: 3.0.3
+info:
+  title: IAM Notification Center API
+  version: 1.0.0
+  description: First release is in-app notifications only. There is no clear-read/delete operation in this release.
+servers:
+  - url: /api
+tags:
+  - name: Notification inbox
+  - name: Platform notification administration
+paths:
+  /{app}/v1/notifications:
+    get:
+      tags: [Notification inbox]
+      summary: List current user's inbox
+      parameters:
+        - {name: app, in: path, required: true, schema: {type: string, enum: [platform, merchant]}}
+        - {name: page, in: query, schema: {type: integer, minimum: 1, default: 1}}
+        - {name: size, in: query, schema: {type: integer, minimum: 1, maximum: 200, default: 20}}
+        - {name: status, in: query, schema: {type: string, enum: [UNREAD, READ]}}
+        - {name: category, in: query, schema: {type: string, maxLength: 64}}
+      responses:
+        '200': {description: OK, content: {application/json: {schema: {$ref: '#/components/schemas/InboxPageResponse'}}}}
+  /{app}/v1/notifications/unread-count:
+    get:
+      tags: [Notification inbox]
+      summary: Count current user's unread inbox messages
+      parameters:
+        - {name: app, in: path, required: true, schema: {type: string, enum: [platform, merchant]}}
+      responses:
+        '200': {description: OK, content: {application/json: {schema: {$ref: '#/components/schemas/UnreadCountResponse'}}}}
+  /{app}/v1/notifications/{id}:
+    get:
+      tags: [Notification inbox]
+      summary: Get one inbox message
+      parameters:
+        - {name: app, in: path, required: true, schema: {type: string, enum: [platform, merchant]}}
+        - {name: id, in: path, required: true, schema: {type: integer, format: int64}}
+      responses:
+        '200': {description: OK, content: {application/json: {schema: {$ref: '#/components/schemas/InboxDetailResponse'}}}}
+  /{app}/v1/notifications/{id}/read:
+    put:
+      tags: [Notification inbox]
+      summary: Mark one message as read (idempotent)
+      parameters:
+        - {name: app, in: path, required: true, schema: {type: string, enum: [platform, merchant]}}
+        - {name: id, in: path, required: true, schema: {type: integer, format: int64}}
+      responses:
+        '200': {description: OK, content: {application/json: {schema: {$ref: '#/components/schemas/InboxDetailResponse'}}}}
+  /{app}/v1/notifications/read-all:
+    put:
+      tags: [Notification inbox]
+      summary: Mark all current-user messages as read (idempotent)
+      parameters:
+        - {name: app, in: path, required: true, schema: {type: string, enum: [platform, merchant]}}
+      responses:
+        '200': {description: OK, content: {application/json: {schema: {$ref: '#/components/schemas/ReadAllResponse'}}}}
+  /platform/v1/notifications:
+    post:
+      tags: [Platform notification administration]
+      summary: Create an in-app notification task
+      responses:
+        '200': {description: OK, content: {application/json: {schema: {$ref: '#/components/schemas/TaskResponse'}}}}
+  /platform/v1/notification-templates:
+    get:
+      tags: [Platform notification administration]
+      summary: List templates
+      parameters: [{name: page, in: query, schema: {type: integer, minimum: 1, default: 1}}, {name: size, in: query, schema: {type: integer, minimum: 1, maximum: 200, default: 20}}, {name: status, in: query, schema: {type: string, enum: [DRAFT, ACTIVE, DISABLED]}}]
+      responses: {'200': {description: OK, content: {application/json: {schema: {$ref: '#/components/schemas/TemplatePageResponse'}}}}}
+    post:
+      tags: [Platform notification administration]
+      summary: Create a DRAFT template
+      responses: {'200': {description: OK, content: {application/json: {schema: {$ref: '#/components/schemas/TemplateResponse'}}}}}
+  /platform/v1/notification-templates/{id}:
+    put:
+      tags: [Platform notification administration]
+      summary: Edit a DRAFT template only
+      responses: {'200': {description: OK, content: {application/json: {schema: {$ref: '#/components/schemas/TemplateResponse'}}}}}
+  /platform/v1/notification-templates/{id}/status:
+    put:
+      tags: [Platform notification administration]
+      summary: Activate or disable a template; only DRAFT->ACTIVE or ACTIVE->DISABLED
+      responses: {'200': {description: OK, content: {application/json: {schema: {$ref: '#/components/schemas/TemplateResponse'}}}}}
+  /platform/v1/notification-tasks:
+    get:
+      tags: [Platform notification administration]
+      summary: List tasks
+      parameters: [{name: page, in: query, schema: {type: integer, minimum: 1, default: 1}}, {name: size, in: query, schema: {type: integer, minimum: 1, maximum: 200, default: 20}}, {name: status, in: query, schema: {type: string, enum: [CREATED, SCHEDULED, DISPATCHING, RETRYING, SENT, DEAD, CANCELLED]}}]
+      responses: {'200': {description: OK, content: {application/json: {schema: {$ref: '#/components/schemas/TaskPageResponse'}}}}}
+  /platform/v1/notification-tasks/{id}/cancel:
+    put:
+      tags: [Platform notification administration]
+      summary: Cancel CREATED or SCHEDULED task
+      responses: {'200': {description: OK, content: {application/json: {schema: {$ref: '#/components/schemas/TaskResponse'}}}}}
+  /platform/v1/notification-tasks/{id}/retry:
+    put:
+      tags: [Platform notification administration]
+      summary: Retry RETRYING or DEAD task
+      responses: {'200': {description: OK, content: {application/json: {schema: {$ref: '#/components/schemas/TaskResponse'}}}}}
+components:
+  schemas:
+    PageMeta: {type: object, required: [page, size, total, pages], properties: {page: {type: integer, format: int64}, size: {type: integer, format: int64}, total: {type: integer, format: int64}, pages: {type: integer, format: int64}}}
+    InboxItem: {type: object, properties: {id: {type: integer, format: int64}, category: {type: string}, title: {type: string}, status: {type: string, enum: [UNREAD, READ]}, sentAt: {type: string, format: date-time}, readAt: {type: string, format: date-time, nullable: true}}}
+    InboxDetail: {allOf: [{$ref: '#/components/schemas/InboxItem'}, {type: object, properties: {body: {type: string}, sourceType: {type: string}, sourceId: {type: string}}}]}
+    InboxPageResponse: {type: object, properties: {code: {type: string, example: '200'}, data: {type: object, properties: {records: {type: array, items: {$ref: '#/components/schemas/InboxItem'}}, page: {type: integer}, size: {type: integer}, total: {type: integer}, pages: {type: integer}}}}}
+    InboxDetailResponse: {type: object, properties: {code: {type: string, example: '200'}, data: {$ref: '#/components/schemas/InboxDetail'}}}
+    UnreadCountResponse: {type: object, properties: {code: {type: string, example: '200'}, data: {type: object, properties: {unreadCount: {type: integer, format: int64}}}}}
+    ReadAllResponse: {type: object, properties: {code: {type: string, example: '200'}, data: {type: object, properties: {updatedCount: {type: integer, format: int64}}}}}
+    CreateNotificationRequest: {type: object, required: [tenantId, templateCode, recipientType, variables, idempotencyKey], properties: {tenantId: {type: integer, format: int64, minimum: 0}, templateCode: {type: string, maxLength: 64}, recipientType: {type: string, enum: [USER, MEMBERSHIP, TENANT_ROLE, TENANT_ALL, PLATFORM_ROLE]}, recipientIds: {type: array, maxItems: 1000, items: {type: integer, format: int64}}, roleCode: {type: string, maxLength: 64}, variables: {type: object, additionalProperties: {type: string}}, scheduledAt: {type: string, format: date-time, nullable: true}, idempotencyKey: {type: string, minLength: 8, maxLength: 128}, sourceEventId: {type: string, maxLength: 128, nullable: true}}}
+    TemplateResponse: {type: object, properties: {id: {type: integer, format: int64}, templateCode: {type: string}, templateName: {type: string}, category: {type: string}, channel: {type: string, enum: [IN_APP]}, titleTemplate: {type: string}, bodyTemplate: {type: string}, variableWhitelist: {type: array, items: {type: string}}, status: {type: string, enum: [DRAFT, ACTIVE, DISABLED]}, version: {type: integer}}}
+    TemplatePageResponse: {type: object, properties: {code: {type: string, example: '200'}, data: {type: object, properties: {records: {type: array, items: {$ref: '#/components/schemas/TemplateResponse'}}, page: {type: integer}, size: {type: integer}, total: {type: integer}, pages: {type: integer}}}}}
+    TaskResponse: {type: object, properties: {id: {type: integer, format: int64}, taskNo: {type: string}, status: {type: string, enum: [CREATED, SCHEDULED, DISPATCHING, RETRYING, SENT, DEAD, CANCELLED]}, recipientCount: {type: integer}, scheduledAt: {type: string, format: date-time, nullable: true}, sentAt: {type: string, format: date-time, nullable: true}, duplicated: {type: boolean}}}
+    TaskPageResponse: {type: object, properties: {code: {type: string, example: '200'}, data: {type: object, properties: {records: {type: array, items: {$ref: '#/components/schemas/TaskResponse'}}, page: {type: integer}, size: {type: integer}, total: {type: integer}, pages: {type: integer}}}}}