@djvlc/openapi-admin-client 1.5.0 → 1.6.1

package/openapi/src/components/schemas/_index.yaml

@@ -0,0 +1,1165 @@
+# Schema 组件索引
+
+# ============================================================================
+# 通用
+# ============================================================================
+
+PaginationMeta:
+  type: object
+  required: [page, limit, total, totalPages]
+  properties:
+    page:
+      type: integer
+      minimum: 1
+      description: 当前页码
+    limit:
+      type: integer
+      minimum: 1
+      maximum: 100
+      description: 每页数量
+    total:
+      type: integer
+      minimum: 0
+      description: 总记录数
+    totalPages:
+      type: integer
+      minimum: 0
+      description: 总页数
+
+ErrorResponse:
+  type: object
+  required: [code, message]
+  properties:
+    code:
+      type: string
+      description: 错误码
+    message:
+      type: string
+      description: 错误消息
+    details:
+      type: array
+      items:
+        $ref: '#/ErrorDetail'
+      description: 错误详情
+
+ErrorDetail:
+  type: object
+  properties:
+    field:
+      type: string
+      description: 字段名
+    message:
+      type: string
+      description: 字段错误信息
+    code:
+      type: string
+      description: 字段错误码
+
+# ============================================================================
+# 页面相关
+# ============================================================================
+
+PageInfo:
+  type: object
+  required: [id, title, status, createdAt, updatedAt]
+  properties:
+    id:
+      type: string
+      description: 页面 ID
+    title:
+      type: string
+      description: 页面标题
+    description:
+      type: string
+      description: 页面描述
+    status:
+      type: string
+      enum: [draft, published, archived]
+      description: 页面状态
+    tags:
+      type: array
+      items:
+        type: string
+      description: 标签
+    currentVersion:
+      type: string
+      description: 当前发布版本
+    createdAt:
+      type: string
+      format: date-time
+      description: 创建时间
+    updatedAt:
+      type: string
+      format: date-time
+      description: 更新时间
+    createdBy:
+      type: string
+      description: 创建者 ID
+    updatedBy:
+      type: string
+      description: 更新者 ID
+
+PageListResponse:
+  type: object
+  required: [data, meta]
+  properties:
+    data:
+      type: array
+      items:
+        $ref: '#/PageInfo'
+    meta:
+      $ref: '#/PaginationMeta'
+
+PageResponse:
+  type: object
+  required: [data]
+  properties:
+    data:
+      $ref: '#/PageInfo'
+
+CreatePageRequest:
+  type: object
+  required: [title]
+  properties:
+    title:
+      type: string
+      minLength: 1
+      maxLength: 255
+      description: 页面标题
+    description:
+      type: string
+      maxLength: 1024
+      description: 页面描述
+    tags:
+      type: array
+      items:
+        type: string
+      description: 标签
+    templateId:
+      type: string
+      description: 模板 ID（可选，从模板创建）
+
+UpdatePageRequest:
+  type: object
+  properties:
+    title:
+      type: string
+      minLength: 1
+      maxLength: 255
+      description: 页面标题
+    description:
+      type: string
+      maxLength: 1024
+      description: 页面描述
+    tags:
+      type: array
+      items:
+        type: string
+      description: 标签
+
+# ============================================================================
+# 草稿相关
+# ============================================================================
+
+DraftResponse:
+  type: object
+  required: [data]
+  properties:
+    data:
+      $ref: '#/DraftData'
+
+DraftData:
+  type: object
+  required: [pageId, content, updatedAt]
+  properties:
+    pageId:
+      type: string
+      description: 页面 ID
+    content:
+      type: object
+      description: 页面 Schema 内容
+    baseVersion:
+      type: string
+      description: 基于的版本号
+    updatedAt:
+      type: string
+      format: date-time
+      description: 最后更新时间
+    updatedBy:
+      type: string
+      description: 最后更新者 ID
+    lockInfo:
+      $ref: '#/LockInfo'
+
+LockInfo:
+  type: object
+  properties:
+    lockedBy:
+      type: string
+      description: 锁定者 ID
+    lockedAt:
+      type: string
+      format: date-time
+      description: 锁定时间
+    expiresAt:
+      type: string
+      format: date-time
+      description: 锁定过期时间
+
+SaveDraftRequest:
+  type: object
+  required: [content]
+  properties:
+    content:
+      type: object
+      description: 页面 Schema 内容
+    baseVersion:
+      type: string
+      description: 基于的版本号（用于冲突检测）
+    force:
+      type: boolean
+      default: false
+      description: 是否强制保存（忽略冲突）
+
+# ============================================================================
+# 版本相关
+# ============================================================================
+
+VersionInfo:
+  type: object
+  required: [id, version, status, createdAt]
+  properties:
+    id:
+      type: string
+      description: 版本 ID
+    version:
+      type: string
+      pattern: '^\d+\.\d+\.\d+$'
+      description: 语义化版本号
+    status:
+      type: string
+      enum: [active, inactive, deprecated]
+      description: 版本状态
+    changelog:
+      type: string
+      description: 变更日志
+    integrity:
+      type: string
+      description: 完整性哈希
+    createdAt:
+      type: string
+      format: date-time
+      description: 创建时间
+    createdBy:
+      type: string
+      description: 创建者 ID
+    rolloutPercentage:
+      type: integer
+      minimum: 0
+      maximum: 100
+      description: 灰度发布百分比
+
+VersionListResponse:
+  type: object
+  required: [data, meta]
+  properties:
+    data:
+      type: array
+      items:
+        $ref: '#/VersionInfo'
+    meta:
+      $ref: '#/PaginationMeta'
+
+VersionResponse:
+  type: object
+  required: [data]
+  properties:
+    data:
+      allOf:
+        - $ref: '#/VersionInfo'
+        - type: object
+          properties:
+            content:
+              type: object
+              description: 页面 Schema 内容
+
+PublishRequest:
+  type: object
+  properties:
+    changelog:
+      type: string
+      maxLength: 2048
+      description: 变更日志
+    versionBump:
+      type: string
+      enum: [major, minor, patch]
+      default: patch
+      description: 版本号升级类型
+    rollout:
+      $ref: '#/RolloutConfig'
+
+RolloutConfig:
+  type: object
+  properties:
+    percentage:
+      type: integer
+      minimum: 0
+      maximum: 100
+      default: 100
+      description: 灰度发布百分比
+    targetGroups:
+      type: array
+      items:
+        type: string
+      description: 目标用户组
+
+PublishResponse:
+  type: object
+  required: [data]
+  properties:
+    data:
+      $ref: '#/VersionInfo'
+
+RollbackRequest:
+  type: object
+  required: [targetVersion]
+  properties:
+    targetVersion:
+      type: string
+      description: 目标版本 ID 或版本号
+    reason:
+      type: string
+      maxLength: 1024
+      description: 回滚原因
+
+# ============================================================================
+# 组件相关
+# ============================================================================
+
+ComponentInfo:
+  type: object
+  required: [id, name, category, status]
+  properties:
+    id:
+      type: string
+      description: 组件 ID
+    name:
+      type: string
+      description: 组件名称
+    displayName:
+      type: string
+      description: 显示名称
+    description:
+      type: string
+      description: 组件描述
+    category:
+      type: string
+      description: 组件分类
+    status:
+      type: string
+      enum: [active, deprecated, disabled]
+      description: 组件状态
+    latestVersion:
+      type: string
+      description: 最新版本号
+    icon:
+      type: string
+      description: 图标 URL
+
+ComponentListResponse:
+  type: object
+  required: [data, meta]
+  properties:
+    data:
+      type: array
+      items:
+        $ref: '#/ComponentInfo'
+    meta:
+      $ref: '#/PaginationMeta'
+
+ComponentVersionInfo:
+  type: object
+  required: [id, version, status, createdAt]
+  properties:
+    id:
+      type: string
+      description: 版本 ID
+    version:
+      type: string
+      pattern: '^\d+\.\d+\.\d+$'
+      description: 语义化版本号
+    status:
+      type: string
+      enum: [active, deprecated, disabled]
+      description: 版本状态
+    changelog:
+      type: string
+      description: 变更日志
+    integrity:
+      type: string
+      description: 完整性哈希
+    createdAt:
+      type: string
+      format: date-time
+      description: 创建时间
+
+ComponentVersionListResponse:
+  type: object
+  required: [data, meta]
+  properties:
+    data:
+      type: array
+      items:
+        $ref: '#/ComponentVersionInfo'
+    meta:
+      $ref: '#/PaginationMeta'
+
+ComponentVersionResponse:
+  type: object
+  required: [data]
+  properties:
+    data:
+      $ref: '#/ComponentVersionInfo'
+
+UpdateComponentStatusRequest:
+  type: object
+  required: [status]
+  properties:
+    status:
+      type: string
+      enum: [active, deprecated, disabled]
+      description: 新状态
+    reason:
+      type: string
+      maxLength: 1024
+      description: 状态变更原因
+
+# ============================================================================
+# 运维相关
+# ============================================================================
+
+KillSwitchStatusResponse:
+  type: object
+  required: [data]
+  properties:
+    data:
+      type: object
+      required: [enabled]
+      properties:
+        enabled:
+          type: boolean
+          description: 是否启用全局 Kill Switch
+        enabledAt:
+          type: string
+          format: date-time
+          description: 启用时间
+        enabledBy:
+          type: string
+          description: 启用者 ID
+        reason:
+          type: string
+          description: 启用原因
+        affectedPages:
+          type: integer
+          description: 受影响的页面数量
+
+PageKillSwitchStatusResponse:
+  type: object
+  required: [data]
+  properties:
+    data:
+      type: object
+      required: [pageId, enabled]
+      properties:
+        pageId:
+          type: string
+          description: 页面 ID
+        enabled:
+          type: boolean
+          description: 是否启用 Kill Switch
+        enabledAt:
+          type: string
+          format: date-time
+          description: 启用时间
+        enabledBy:
+          type: string
+          description: 启用者 ID
+        reason:
+          type: string
+          description: 启用原因
+        fallbackUrl:
+          type: string
+          format: uri
+          description: 降级跳转 URL
+
+SetKillSwitchRequest:
+  type: object
+  required: [enabled]
+  properties:
+    enabled:
+      type: boolean
+      description: 是否启用 Kill Switch
+    reason:
+      type: string
+      maxLength: 1024
+      description: 原因
+    fallbackUrl:
+      type: string
+      format: uri
+      description: 降级跳转 URL（仅页面级别）
+
+# ============================================================================
+# Rollout 灰度发布相关
+# ============================================================================
+
+RolloutStrategy:
+  type: object
+  required: [id, name, type, config]
+  properties:
+    id:
+      type: string
+      description: 策略 ID
+    name:
+      type: string
+      description: 策略名称
+    type:
+      type: string
+      enum: [percentage, userGroup, feature, gradual]
+      description: 策略类型
+    config:
+      type: object
+      additionalProperties: true
+      description: 策略配置
+    priority:
+      type: integer
+      minimum: 0
+      description: 优先级
+    enabled:
+      type: boolean
+      description: 是否启用
+    createdAt:
+      type: string
+      format: date-time
+      description: 创建时间
+    updatedAt:
+      type: string
+      format: date-time
+      description: 更新时间
+
+UpdateRolloutRequest:
+  type: object
+  properties:
+    percentage:
+      type: integer
+      minimum: 0
+      maximum: 100
+      description: 灰度发布百分比
+    targetGroups:
+      type: array
+      items:
+        type: string
+      description: 目标用户组
+    enabled:
+      type: boolean
+      description: 是否启用
+
+AddRolloutStrategyRequest:
+  type: object
+  required: [name, type, config]
+  properties:
+    name:
+      type: string
+      minLength: 1
+      maxLength: 255
+      description: 策略名称
+    type:
+      type: string
+      enum: [percentage, userGroup, feature, gradual]
+      description: 策略类型
+    config:
+      type: object
+      additionalProperties: true
+      description: 策略配置
+    priority:
+      type: integer
+      minimum: 0
+      description: 优先级
+    enabled:
+      type: boolean
+      default: true
+      description: 是否启用
+
+UpdateRolloutStrategyRequest:
+  type: object
+  properties:
+    name:
+      type: string
+      minLength: 1
+      maxLength: 255
+      description: 策略名称
+    config:
+      type: object
+      additionalProperties: true
+      description: 策略配置
+    priority:
+      type: integer
+      minimum: 0
+      description: 优先级
+    enabled:
+      type: boolean
+      description: 是否启用
+
+# ============================================================================
+# Action Definition 相关
+# ============================================================================
+
+ActionDefinitionInfo:
+  type: object
+  required: [id, name, type, status, createdAt]
+  properties:
+    id:
+      type: string
+      description: 定义 ID
+    name:
+      type: string
+      description: 动作名称
+    displayName:
+      type: string
+      description: 显示名称
+    type:
+      type: string
+      enum: [builtin, custom, http, script]
+      description: 动作类型
+    description:
+      type: string
+      description: 描述
+    status:
+      type: string
+      enum: [active, deprecated, disabled]
+      description: 状态
+    latestVersion:
+      type: string
+      description: 最新版本
+    createdAt:
+      type: string
+      format: date-time
+      description: 创建时间
+    updatedAt:
+      type: string
+      format: date-time
+      description: 更新时间
+
+ActionDefinitionDetail:
+  type: object
+  required: [id, name, type, status, spec, createdAt]
+  properties:
+    id:
+      type: string
+      description: 定义 ID
+    name:
+      type: string
+      description: 动作名称
+    displayName:
+      type: string
+      description: 显示名称
+    type:
+      type: string
+      enum: [builtin, custom, http, script]
+      description: 动作类型
+    description:
+      type: string
+      description: 描述
+    status:
+      type: string
+      enum: [active, deprecated, disabled]
+      description: 状态
+    spec:
+      type: object
+      description: 动作规范定义
+    versions:
+      type: array
+      items:
+        $ref: '#/DefinitionVersionInfo'
+      description: 版本列表
+    createdAt:
+      type: string
+      format: date-time
+      description: 创建时间
+    updatedAt:
+      type: string
+      format: date-time
+      description: 更新时间
+
+CreateActionDefinitionRequest:
+  type: object
+  required: [name, type]
+  properties:
+    name:
+      type: string
+      minLength: 1
+      maxLength: 255
+      description: 动作名称
+    displayName:
+      type: string
+      maxLength: 255
+      description: 显示名称
+    type:
+      type: string
+      enum: [builtin, custom, http, script]
+      description: 动作类型
+    description:
+      type: string
+      maxLength: 1024
+      description: 描述
+    spec:
+      type: object
+      description: 动作规范定义
+
+UpdateActionDefinitionRequest:
+  type: object
+  properties:
+    displayName:
+      type: string
+      maxLength: 255
+      description: 显示名称
+    description:
+      type: string
+      maxLength: 1024
+      description: 描述
+    spec:
+      type: object
+      description: 动作规范定义
+    status:
+      type: string
+      enum: [active, deprecated, disabled]
+      description: 状态
+
+# ============================================================================
+# Definition Version 相关
+# ============================================================================
+
+DefinitionVersionInfo:
+  type: object
+  required: [id, version, status, createdAt]
+  properties:
+    id:
+      type: string
+      description: 版本 ID
+    version:
+      type: string
+      pattern: '^\d+\.\d+\.\d+$'
+      description: 语义化版本号
+    status:
+      type: string
+      enum: [active, deprecated, disabled]
+      description: 版本状态
+    changelog:
+      type: string
+      description: 变更日志
+    integrity:
+      type: string
+      description: 完整性哈希
+    createdAt:
+      type: string
+      format: date-time
+      description: 创建时间
+    createdBy:
+      type: string
+      description: 创建者 ID
+
+PublishDefinitionVersionRequest:
+  type: object
+  properties:
+    changelog:
+      type: string
+      maxLength: 2048
+      description: 变更日志
+    versionBump:
+      type: string
+      enum: [major, minor, patch]
+      default: patch
+      description: 版本号升级类型
+
+# ============================================================================
+# Data Query Definition 相关
+# ============================================================================
+
+DataQueryDefinitionInfo:
+  type: object
+  required: [id, name, type, status, createdAt]
+  properties:
+    id:
+      type: string
+      description: 定义 ID
+    name:
+      type: string
+      description: 查询名称
+    displayName:
+      type: string
+      description: 显示名称
+    type:
+      type: string
+      enum: [http, graphql, sql, custom]
+      description: 查询类型
+    description:
+      type: string
+      description: 描述
+    status:
+      type: string
+      enum: [active, deprecated, disabled]
+      description: 状态
+    latestVersion:
+      type: string
+      description: 最新版本
+    createdAt:
+      type: string
+      format: date-time
+      description: 创建时间
+    updatedAt:
+      type: string
+      format: date-time
+      description: 更新时间
+
+DataQueryDefinitionDetail:
+  type: object
+  required: [id, name, type, status, spec, createdAt]
+  properties:
+    id:
+      type: string
+      description: 定义 ID
+    name:
+      type: string
+      description: 查询名称
+    displayName:
+      type: string
+      description: 显示名称
+    type:
+      type: string
+      enum: [http, graphql, sql, custom]
+      description: 查询类型
+    description:
+      type: string
+      description: 描述
+    status:
+      type: string
+      enum: [active, deprecated, disabled]
+      description: 状态
+    spec:
+      type: object
+      description: 查询规范定义
+    versions:
+      type: array
+      items:
+        $ref: '#/DefinitionVersionInfo'
+      description: 版本列表
+    createdAt:
+      type: string
+      format: date-time
+      description: 创建时间
+    updatedAt:
+      type: string
+      format: date-time
+      description: 更新时间
+
+CreateDataQueryDefinitionRequest:
+  type: object
+  required: [name, type]
+  properties:
+    name:
+      type: string
+      minLength: 1
+      maxLength: 255
+      description: 查询名称
+    displayName:
+      type: string
+      maxLength: 255
+      description: 显示名称
+    type:
+      type: string
+      enum: [http, graphql, sql, custom]
+      description: 查询类型
+    description:
+      type: string
+      maxLength: 1024
+      description: 描述
+    spec:
+      type: object
+      description: 查询规范定义
+
+# ============================================================================
+# Activity 营销活动相关
+# ============================================================================
+
+ActivityInfo:
+  type: object
+  required: [id, name, type, status, createdAt]
+  properties:
+    id:
+      type: string
+      description: 活动 ID
+    name:
+      type: string
+      description: 活动名称
+    type:
+      type: string
+      enum: [signin, lottery, redpack, coupon, custom]
+      description: 活动类型
+    status:
+      type: string
+      enum: [draft, scheduled, active, paused, ended]
+      description: 活动状态
+    startTime:
+      type: string
+      format: date-time
+      description: 开始时间
+    endTime:
+      type: string
+      format: date-time
+      description: 结束时间
+    createdAt:
+      type: string
+      format: date-time
+      description: 创建时间
+    updatedAt:
+      type: string
+      format: date-time
+      description: 更新时间
+
+ActivityDetail:
+  type: object
+  required: [id, name, type, status, config, createdAt]
+  properties:
+    id:
+      type: string
+      description: 活动 ID
+    name:
+      type: string
+      description: 活动名称
+    type:
+      type: string
+      enum: [signin, lottery, redpack, coupon, custom]
+      description: 活动类型
+    status:
+      type: string
+      enum: [draft, scheduled, active, paused, ended]
+      description: 活动状态
+    description:
+      type: string
+      description: 活动描述
+    config:
+      type: object
+      additionalProperties: true
+      description: 活动配置
+    rules:
+      type: object
+      additionalProperties: true
+      description: 活动规则
+    startTime:
+      type: string
+      format: date-time
+      description: 开始时间
+    endTime:
+      type: string
+      format: date-time
+      description: 结束时间
+    createdAt:
+      type: string
+      format: date-time
+      description: 创建时间
+    updatedAt:
+      type: string
+      format: date-time
+      description: 更新时间
+    createdBy:
+      type: string
+      description: 创建者 ID
+
+CreateActivityRequest:
+  type: object
+  required: [name, type]
+  properties:
+    name:
+      type: string
+      minLength: 1
+      maxLength: 255
+      description: 活动名称
+    type:
+      type: string
+      enum: [signin, lottery, redpack, coupon, custom]
+      description: 活动类型
+    description:
+      type: string
+      maxLength: 1024
+      description: 活动描述
+    config:
+      type: object
+      additionalProperties: true
+      description: 活动配置
+    rules:
+      type: object
+      additionalProperties: true
+      description: 活动规则
+    startTime:
+      type: string
+      format: date-time
+      description: 开始时间
+    endTime:
+      type: string
+      format: date-time
+      description: 结束时间
+
+UpdateActivityRequest:
+  type: object
+  properties:
+    name:
+      type: string
+      minLength: 1
+      maxLength: 255
+      description: 活动名称
+    description:
+      type: string
+      maxLength: 1024
+      description: 活动描述
+    config:
+      type: object
+      additionalProperties: true
+      description: 活动配置
+    rules:
+      type: object
+      additionalProperties: true
+      description: 活动规则
+    startTime:
+      type: string
+      format: date-time
+      description: 开始时间
+    endTime:
+      type: string
+      format: date-time
+      description: 结束时间
+
+ActivityStats:
+  type: object
+  properties:
+    totalParticipants:
+      type: integer
+      description: 总参与人数
+    todayParticipants:
+      type: integer
+      description: 今日参与人数
+    totalRewards:
+      type: integer
+      description: 总发放奖励数
+    todayRewards:
+      type: integer
+      description: 今日发放奖励数
+    conversionRate:
+      type: number
+      format: float
+      description: 转化率
+
+# ============================================================================
+# Audit 审计日志相关
+# ============================================================================
+
+AuditLogEntry:
+  type: object
+  required: [id, action, resource, timestamp]
+  properties:
+    id:
+      type: string
+      description: 日志 ID
+    action:
+      type: string
+      description: 操作类型
+    resource:
+      type: string
+      description: 资源类型
+    resourceId:
+      type: string
+      description: 资源 ID
+    userId:
+      type: string
+      description: 操作用户 ID
+    userName:
+      type: string
+      description: 操作用户名
+    timestamp:
+      type: string
+      format: date-time
+      description: 操作时间
+    status:
+      type: string
+      enum: [success, failed]
+      description: 操作状态
+
+AuditLogDetail:
+  type: object
+  required: [id, action, resource, timestamp]
+  properties:
+    id:
+      type: string
+      description: 日志 ID
+    action:
+      type: string
+      description: 操作类型
+    resource:
+      type: string
+      description: 资源类型
+    resourceId:
+      type: string
+      description: 资源 ID
+    userId:
+      type: string
+      description: 操作用户 ID
+    userName:
+      type: string
+      description: 操作用户名
+    timestamp:
+      type: string
+      format: date-time
+      description: 操作时间
+    status:
+      type: string
+      enum: [success, failed]
+      description: 操作状态
+    changes:
+      type: object
+      properties:
+        before:
+          type: object
+          additionalProperties: true
+          description: 变更前数据
+        after:
+          type: object
+          additionalProperties: true
+          description: 变更后数据
+    metadata:
+      type: object
+      additionalProperties: true
+      description: 元数据
+    ipAddress:
+      type: string
+      description: IP 地址
+    userAgent:
+      type: string
+      description: User Agent
+
+AuditStats:
+  type: object
+  properties:
+    totalLogs:
+      type: integer
+      description: 总日志数
+    todayLogs:
+      type: integer
+      description: 今日日志数
+    actionBreakdown:
+      type: object
+      additionalProperties:
+        type: integer
+      description: 按操作类型统计
+    resourceBreakdown:
+      type: object
+      additionalProperties:
+        type: integer
+      description: 按资源类型统计