@djvlc/openapi-admin-client 1.6.1 → 1.6.3

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

@@ -615,7 +615,7 @@ UpdateRolloutStrategyRequest:
 
 ActionDefinitionInfo:
   type: object
-  required: [id, name, type, status, createdAt]
+  required: [id, name, actionType, status, createdAt]
   properties:
     id:
       type: string
@@ -626,17 +626,17 @@ ActionDefinitionInfo:
     displayName:
       type: string
       description: 显示名称
-    type:
+    actionType:
       type: string
-      enum: [builtin, custom, http, script]
+      enum: [claim, signin, lottery, reserve, bind, task_complete, vote, share, form_submit, custom]
       description: 动作类型
     description:
       type: string
       description: 描述
     status:
       type: string
-      enum: [active, deprecated, disabled]
-      description: 状态
+      enum: [draft, stable, deprecated, blocked]
+      description: 状态（状态机：draft → stable → deprecated → blocked）
     latestVersion:
       type: string
       description: 最新版本
@@ -651,7 +651,7 @@ ActionDefinitionInfo:
 
 ActionDefinitionDetail:
   type: object
-  required: [id, name, type, status, spec, createdAt]
+  required: [id, name, actionType, status, spec, createdAt]
   properties:
     id:
       type: string
@@ -662,17 +662,17 @@ ActionDefinitionDetail:
     displayName:
       type: string
       description: 显示名称
-    type:
+    actionType:
       type: string
-      enum: [builtin, custom, http, script]
+      enum: [claim, signin, lottery, reserve, bind, task_complete, vote, share, form_submit, custom]
       description: 动作类型
     description:
       type: string
       description: 描述
     status:
       type: string
-      enum: [active, deprecated, disabled]
-      description: 状态
+      enum: [draft, stable, deprecated, blocked]
+      description: 状态（状态机：draft → stable → deprecated → blocked）
     spec:
       type: object
       description: 动作规范定义
@@ -692,7 +692,7 @@ ActionDefinitionDetail:
 
 CreateActionDefinitionRequest:
   type: object
-  required: [name, type]
+  required: [name, actionType]
   properties:
     name:
       type: string
@@ -703,9 +703,9 @@ CreateActionDefinitionRequest:
       type: string
       maxLength: 255
       description: 显示名称
-    type:
+    actionType:
       type: string
-      enum: [builtin, custom, http, script]
+      enum: [claim, signin, lottery, reserve, bind, task_complete, vote, share, form_submit, custom]
       description: 动作类型
     description:
       type: string
@@ -731,7 +731,7 @@ UpdateActionDefinitionRequest:
       description: 动作规范定义
     status:
       type: string
-      enum: [active, deprecated, disabled]
+      enum: [draft, stable, deprecated, blocked]
       description: 状态
 
 # ============================================================================
@@ -751,8 +751,8 @@ DefinitionVersionInfo:
       description: 语义化版本号
     status:
       type: string
-      enum: [active, deprecated, disabled]
-      description: 版本状态
+      enum: [draft, stable, deprecated, blocked]
+      description: 版本状态（状态机：draft → stable → deprecated → blocked）
     changelog:
       type: string
       description: 变更日志
@@ -786,7 +786,7 @@ PublishDefinitionVersionRequest:
 
 DataQueryDefinitionInfo:
   type: object
-  required: [id, name, type, status, createdAt]
+  required: [id, name, sourceType, status, createdAt]
   properties:
     id:
       type: string
@@ -797,17 +797,17 @@ DataQueryDefinitionInfo:
     displayName:
       type: string
       description: 显示名称
-    type:
+    sourceType:
       type: string
-      enum: [http, graphql, sql, custom]
-      description: 查询类型
+      enum: [http, graphql, database, internal, aggregation]
+      description: 数据源类型
     description:
       type: string
       description: 描述
     status:
       type: string
-      enum: [active, deprecated, disabled]
-      description: 状态
+      enum: [draft, stable, deprecated, blocked]
+      description: 状态（状态机：draft → stable → deprecated → blocked）
     latestVersion:
       type: string
       description: 最新版本
@@ -822,7 +822,7 @@ DataQueryDefinitionInfo:
 
 DataQueryDefinitionDetail:
   type: object
-  required: [id, name, type, status, spec, createdAt]
+  required: [id, name, sourceType, status, spec, createdAt]
   properties:
     id:
       type: string
@@ -833,17 +833,17 @@ DataQueryDefinitionDetail:
     displayName:
       type: string
       description: 显示名称
-    type:
+    sourceType:
       type: string
-      enum: [http, graphql, sql, custom]
-      description: 查询类型
+      enum: [http, graphql, database, internal, aggregation]
+      description: 数据源类型
     description:
       type: string
       description: 描述
     status:
       type: string
-      enum: [active, deprecated, disabled]
-      description: 状态
+      enum: [draft, stable, deprecated, blocked]
+      description: 状态（状态机：draft → stable → deprecated → blocked）
     spec:
       type: object
       description: 查询规范定义
@@ -863,7 +863,7 @@ DataQueryDefinitionDetail:
 
 CreateDataQueryDefinitionRequest:
   type: object
-  required: [name, type]
+  required: [name, sourceType]
   properties:
     name:
       type: string
@@ -874,10 +874,25 @@ CreateDataQueryDefinitionRequest:
       type: string
       maxLength: 255
       description: 显示名称
-    type:
+    sourceType:
+      type: string
+      enum: [http, graphql, database, internal, aggregation]
+      description: 数据源类型
+    description:
+      type: string
+      maxLength: 1024
+      description: 描述
+    spec:
+      type: object
+      description: 查询规范定义
+
+UpdateDataQueryDefinitionRequest:
+  type: object
+  properties:
+    displayName:
       type: string
-      enum: [http, graphql, sql, custom]
-      description: 查询类型
+      maxLength: 255
+      description: 显示名称
     description:
       type: string
       maxLength: 1024
@@ -885,6 +900,88 @@ CreateDataQueryDefinitionRequest:
     spec:
       type: object
       description: 查询规范定义
+    status:
+      type: string
+      enum: [draft, stable, deprecated, blocked]
+      description: 状态
+
+# ============================================================================
+# Preview 预览相关
+# ============================================================================
+
+PreviewTokenInfo:
+  type: object
+  required: [token, pageId, expiresAt]
+  properties:
+    token:
+      type: string
+      description: 预览 Token
+    pageId:
+      type: string
+      description: 页面 ID
+    draftVersion:
+      type: string
+      description: 草稿版本标识
+    previewUrl:
+      type: string
+      format: uri
+      description: 预览 URL
+    deviceType:
+      type: string
+      enum: [mobile, tablet, desktop]
+      description: 预览设备类型
+    context:
+      type: object
+      additionalProperties: true
+      description: 预览上下文
+    createdAt:
+      type: string
+      format: date-time
+      description: 创建时间
+    expiresAt:
+      type: string
+      format: date-time
+      description: 过期时间
+    createdBy:
+      type: string
+      description: 创建者 ID
+
+# ============================================================================
+# Health 健康检查相关
+# ============================================================================
+
+HealthResponse:
+  type: object
+  required: [status, version]
+  properties:
+    status:
+      type: string
+      enum: [healthy, degraded, unhealthy]
+      description: 服务状态
+    version:
+      type: string
+      description: 服务版本
+    uptime:
+      type: integer
+      description: 运行时间（秒）
+    timestamp:
+      type: string
+      format: date-time
+      description: 检查时间
+    dependencies:
+      type: object
+      additionalProperties:
+        type: object
+        properties:
+          status:
+            type: string
+            enum: [healthy, degraded, unhealthy]
+          latency:
+            type: integer
+            description: 延迟（毫秒）
+          message:
+            type: string
+      description: 依赖服务状态
 
 # ============================================================================
 # Activity 营销活动相关

package/openapi/src/openapi.yaml

@@ -1,16 +1,33 @@
 openapi: 3.0.3
 info:
   title: DJVLC Admin API
-  version: 1.0.0
+  version: 2.0.0
   description: |
-    DJVLC 低代码平台管理端 API
+    DJVLC 低代码平台管理端 API（控制面）
     
     提供以下功能：
     - 页面管理（创建、更新、删除）
     - 草稿管理（保存、获取）
     - 版本管理（发布、回滚）
+    - 预览管理（生成预览 Token）
     - 组件管理（状态控制）
+    - 灰度发布（Rollout）
+    - Definition 管理（Action/DataQuery）
+    - 活动管理
+    - 审计日志
     - 运维操作（Kill Switch）
+    - 健康检查
+    
+    ## API 设计规范
+    - 只使用 GET 和 POST 方法
+    - GET：查询操作
+    - POST：创建、更新、删除等变更操作
+    - 使用语义化路由（如 /update, /delete, /publish）
+    
+    核心原则：
+    - 控制面复杂，但可审计
+    - 所有写操作可追溯、可回滚、可审计
+    - Definition 版本化，确保回滚不失真
   contact:
     name: DJVLC Team
     email: dev@djvlc.com
@@ -29,6 +46,8 @@ tags:
     description: 草稿管理
   - name: Versions
     description: 版本管理
+  - name: Preview
+    description: 预览管理
   - name: Rollout
     description: 灰度发布
   - name: Components
@@ -41,17 +60,29 @@ tags:
     description: 审计日志
   - name: Operations
     description: 运维操作
+  - name: Health
+    description: 健康检查
 
 paths:
   # 页面管理
   /pages:
     $ref: './paths/pages.yaml#/pages'
+  /pages/create:
+    $ref: './paths/pages.yaml#/create'
   /pages/{pageId}:
     $ref: './paths/pages.yaml#/pages~1{pageId}'
+  /pages/{pageId}/update:
+    $ref: './paths/pages.yaml#/update'
+  /pages/{pageId}/delete:
+    $ref: './paths/pages.yaml#/delete'
   
   # 草稿管理
   /pages/{pageId}/draft:
     $ref: './paths/drafts.yaml#/draft'
+  /pages/{pageId}/draft/save:
+    $ref: './paths/drafts.yaml#/save'
+  /pages/{pageId}/draft/discard:
+    $ref: './paths/drafts.yaml#/discard'
   
   # 版本管理
   /pages/{pageId}/versions:
@@ -63,33 +94,57 @@ paths:
   /pages/{pageId}/rollback:
     $ref: './paths/versions.yaml#/rollback'
   
+  # 预览管理
+  /pages/{pageId}/preview:
+    $ref: './paths/preview.yaml#/preview'
+  /pages/{pageId}/preview/tokens:
+    $ref: './paths/preview.yaml#/previewList'
+  /preview/tokens/{token}:
+    $ref: './paths/preview.yaml#/previewToken'
+  /preview/tokens/{token}/revoke:
+    $ref: './paths/preview.yaml#/previewTokenRevoke'
+  
   # 组件管理
   /components:
     $ref: './paths/components.yaml#/components'
   /components/{componentId}/versions:
     $ref: './paths/components.yaml#/componentVersions'
-  /components/{componentId}/versions/{versionId}/status:
-    $ref: './paths/components.yaml#/componentVersionStatus'
+  /components/{componentId}/versions/{versionId}/status/update:
+    $ref: './paths/components.yaml#/componentVersionStatusUpdate'
   
   # 灰度发布
   /pages/{pageId}/rollout:
     $ref: './paths/rollout.yaml#/rollout'
-  /pages/{pageId}/rollout/strategies:
+  /pages/{pageId}/rollout/update:
+    $ref: './paths/rollout.yaml#/rolloutUpdate'
+  /pages/{pageId}/rollout/remove:
+    $ref: './paths/rollout.yaml#/rolloutRemove'
+  /pages/{pageId}/rollout/strategies/add:
     $ref: './paths/rollout.yaml#/rolloutStrategies'
-  /pages/{pageId}/rollout/strategies/{strategyId}:
-    $ref: './paths/rollout.yaml#/rolloutStrategyById'
+  /pages/{pageId}/rollout/strategies/{strategyId}/update:
+    $ref: './paths/rollout.yaml#/rolloutStrategyUpdate'
+  /pages/{pageId}/rollout/strategies/{strategyId}/remove:
+    $ref: './paths/rollout.yaml#/rolloutStrategyRemove'
   
   # Definition 管理
   /definitions/actions:
     $ref: './paths/definitions.yaml#/actionDefinitions'
   /definitions/actions/{definitionId}:
     $ref: './paths/definitions.yaml#/actionDefinitionById'
+  /definitions/actions/{definitionId}/update:
+    $ref: './paths/definitions.yaml#/actionDefinitionUpdate'
+  /definitions/actions/{definitionId}/delete:
+    $ref: './paths/definitions.yaml#/actionDefinitionDelete'
   /definitions/actions/{definitionId}/versions:
     $ref: './paths/definitions.yaml#/actionDefinitionVersions'
   /definitions/queries:
     $ref: './paths/definitions.yaml#/dataQueryDefinitions'
   /definitions/queries/{definitionId}:
     $ref: './paths/definitions.yaml#/dataQueryDefinitionById'
+  /definitions/queries/{definitionId}/update:
+    $ref: './paths/definitions.yaml#/dataQueryDefinitionUpdate'
+  /definitions/queries/{definitionId}/delete:
+    $ref: './paths/definitions.yaml#/dataQueryDefinitionDelete'
   /definitions/queries/{definitionId}/versions:
     $ref: './paths/definitions.yaml#/dataQueryDefinitionVersions'
   
@@ -98,8 +153,12 @@ paths:
     $ref: './paths/activities.yaml#/activities'
   /activities/{activityId}:
     $ref: './paths/activities.yaml#/activityById'
-  /activities/{activityId}/status:
-    $ref: './paths/activities.yaml#/activityStatus'
+  /activities/{activityId}/update:
+    $ref: './paths/activities.yaml#/activityUpdate'
+  /activities/{activityId}/delete:
+    $ref: './paths/activities.yaml#/activityDelete'
+  /activities/{activityId}/status/update:
+    $ref: './paths/activities.yaml#/activityStatusUpdate'
   /activities/{activityId}/stats:
     $ref: './paths/activities.yaml#/activityStats'
   
@@ -114,8 +173,20 @@ paths:
   # 运维操作
   /operations/kill-switch:
     $ref: './paths/operations.yaml#/killSwitch'
+  /operations/kill-switch/set:
+    $ref: './paths/operations.yaml#/killSwitchSet'
   /operations/kill-switch/{pageId}:
     $ref: './paths/operations.yaml#/killSwitchPage'
+  /operations/kill-switch/{pageId}/set:
+    $ref: './paths/operations.yaml#/killSwitchPageSet'
+  
+  # 健康检查
+  /health:
+    $ref: './paths/health.yaml#/health'
+  /health/ready:
+    $ref: './paths/health.yaml#/ready'
+  /health/live:
+    $ref: './paths/health.yaml#/live'
 
 components:
   schemas:

package/openapi/src/paths/activities.yaml

@@ -93,8 +93,9 @@ activityById:
                   $ref: '../components/schemas/_index.yaml#/ActivityDetail'
       '404':
         $ref: '../components/responses/_index.yaml#/NotFound'
-  
-  put:
+
+activityUpdate:
+  post:
     tags:
       - Activities
     summary: 更新活动
@@ -123,8 +124,9 @@ activityById:
                   type: boolean
                 data:
                   $ref: '../components/schemas/_index.yaml#/ActivityInfo'
-  
-  delete:
+
+activityDelete:
+  post:
     tags:
       - Activities
     summary: 删除活动
@@ -135,12 +137,30 @@ activityById:
         required: true
         schema:
           type: string
+    requestBody:
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              reason:
+                type: string
+                description: 删除原因
     responses:
-      '204':
+      '200':
         description: 删除成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                message:
+                  type: string
 
-activityStatus:
-  put:
+activityStatusUpdate:
+  post:
     tags:
       - Activities
     summary: 更新活动状态

package/openapi/src/paths/components.yaml

@@ -56,8 +56,8 @@ componentVersions:
       '500':
         $ref: '../components/responses/_index.yaml#/InternalError'
 
-componentVersionStatus:
-  put:
+componentVersionStatusUpdate:
+  post:
     tags: [Components]
     operationId: updateComponentVersionStatus
     summary: 更新组件版本状态