@djvlc/openapi-admin-client 1.5.0 → 1.6.0

package/openapi/src/openapi.yaml

@@ -0,0 +1,135 @@
+openapi: 3.0.3
+info:
+  title: DJVLC Admin API
+  version: 1.0.0
+  description: |
+    DJVLC 低代码平台管理端 API
+    
+    提供以下功能：
+    - 页面管理（创建、更新、删除）
+    - 草稿管理（保存、获取）
+    - 版本管理（发布、回滚）
+    - 组件管理（状态控制）
+    - 运维操作（Kill Switch）
+  contact:
+    name: DJVLC Team
+    email: dev@djvlc.com
+  license:
+    name: MIT
+    url: https://opensource.org/licenses/MIT
+
+servers:
+  - url: /api/admin
+    description: 管理端 API
+
+tags:
+  - name: Pages
+    description: 页面管理
+  - name: Drafts
+    description: 草稿管理
+  - name: Versions
+    description: 版本管理
+  - name: Rollout
+    description: 灰度发布
+  - name: Components
+    description: 组件管理
+  - name: Definitions
+    description: Definition 管理（Action/DataQuery）
+  - name: Activities
+    description: 活动管理
+  - name: Audit
+    description: 审计日志
+  - name: Operations
+    description: 运维操作
+
+paths:
+  # 页面管理
+  /pages:
+    $ref: './paths/pages.yaml#/pages'
+  /pages/{pageId}:
+    $ref: './paths/pages.yaml#/pages~1{pageId}'
+  
+  # 草稿管理
+  /pages/{pageId}/draft:
+    $ref: './paths/drafts.yaml#/draft'
+  
+  # 版本管理
+  /pages/{pageId}/versions:
+    $ref: './paths/versions.yaml#/versions'
+  /pages/{pageId}/versions/{versionId}:
+    $ref: './paths/versions.yaml#/versions~1{versionId}'
+  /pages/{pageId}/publish:
+    $ref: './paths/versions.yaml#/publish'
+  /pages/{pageId}/rollback:
+    $ref: './paths/versions.yaml#/rollback'
+  
+  # 组件管理
+  /components:
+    $ref: './paths/components.yaml#/components'
+  /components/{componentId}/versions:
+    $ref: './paths/components.yaml#/componentVersions'
+  /components/{componentId}/versions/{versionId}/status:
+    $ref: './paths/components.yaml#/componentVersionStatus'
+  
+  # 灰度发布
+  /pages/{pageId}/rollout:
+    $ref: './paths/rollout.yaml#/rollout'
+  /pages/{pageId}/rollout/strategies:
+    $ref: './paths/rollout.yaml#/rolloutStrategies'
+  /pages/{pageId}/rollout/strategies/{strategyId}:
+    $ref: './paths/rollout.yaml#/rolloutStrategyById'
+  
+  # Definition 管理
+  /definitions/actions:
+    $ref: './paths/definitions.yaml#/actionDefinitions'
+  /definitions/actions/{definitionId}:
+    $ref: './paths/definitions.yaml#/actionDefinitionById'
+  /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}/versions:
+    $ref: './paths/definitions.yaml#/dataQueryDefinitionVersions'
+  
+  # 活动管理
+  /activities:
+    $ref: './paths/activities.yaml#/activities'
+  /activities/{activityId}:
+    $ref: './paths/activities.yaml#/activityById'
+  /activities/{activityId}/status:
+    $ref: './paths/activities.yaml#/activityStatus'
+  /activities/{activityId}/stats:
+    $ref: './paths/activities.yaml#/activityStats'
+  
+  # 审计日志
+  /audit:
+    $ref: './paths/audit.yaml#/audit'
+  /audit/{auditId}:
+    $ref: './paths/audit.yaml#/auditById'
+  /audit/stats:
+    $ref: './paths/audit.yaml#/auditStats'
+  
+  # 运维操作
+  /operations/kill-switch:
+    $ref: './paths/operations.yaml#/killSwitch'
+  /operations/kill-switch/{pageId}:
+    $ref: './paths/operations.yaml#/killSwitchPage'
+
+components:
+  schemas:
+    $ref: './components/schemas/_index.yaml'
+  responses:
+    $ref: './components/responses/_index.yaml'
+  parameters:
+    $ref: './components/parameters/_index.yaml'
+  securitySchemes:
+    BearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+      description: JWT 认证令牌
+
+security:
+  - BearerAuth: []

package/openapi/src/paths/activities.yaml

@@ -0,0 +1,214 @@
+# Activities 活动管理 API
+
+activities:
+  get:
+    tags:
+      - Activities
+    summary: 获取活动列表
+    operationId: listActivities
+    parameters:
+      - name: pageSize
+        in: query
+        schema:
+          type: integer
+          default: 20
+      - name: pageToken
+        in: query
+        schema:
+          type: string
+      - name: type
+        in: query
+        schema:
+          type: string
+          enum: [claim, signin, lottery, reserve, task, vote, share, bind, custom]
+      - name: status
+        in: query
+        schema:
+          type: string
+          enum: [draft, scheduled, active, paused, ended, archived]
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  type: array
+                  items:
+                    $ref: '../components/schemas/_index.yaml#/ActivityInfo'
+                meta:
+                  $ref: '../components/schemas/_index.yaml#/PaginationMeta'
+  
+  post:
+    tags:
+      - Activities
+    summary: 创建活动
+    operationId: createActivity
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: '../components/schemas/_index.yaml#/CreateActivityRequest'
+    responses:
+      '201':
+        description: 创建成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  $ref: '../components/schemas/_index.yaml#/ActivityInfo'
+
+activityById:
+  get:
+    tags:
+      - Activities
+    summary: 获取活动详情
+    operationId: getActivity
+    parameters:
+      - name: activityId
+        in: path
+        required: true
+        schema:
+          type: string
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  $ref: '../components/schemas/_index.yaml#/ActivityDetail'
+      '404':
+        $ref: '../components/responses/_index.yaml#/NotFound'
+  
+  put:
+    tags:
+      - Activities
+    summary: 更新活动
+    operationId: updateActivity
+    parameters:
+      - name: activityId
+        in: path
+        required: true
+        schema:
+          type: string
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: '../components/schemas/_index.yaml#/UpdateActivityRequest'
+    responses:
+      '200':
+        description: 更新成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  $ref: '../components/schemas/_index.yaml#/ActivityInfo'
+  
+  delete:
+    tags:
+      - Activities
+    summary: 删除活动
+    operationId: deleteActivity
+    parameters:
+      - name: activityId
+        in: path
+        required: true
+        schema:
+          type: string
+    responses:
+      '204':
+        description: 删除成功
+
+activityStatus:
+  put:
+    tags:
+      - Activities
+    summary: 更新活动状态
+    operationId: updateActivityStatus
+    parameters:
+      - name: activityId
+        in: path
+        required: true
+        schema:
+          type: string
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            type: object
+            required:
+              - status
+            properties:
+              status:
+                type: string
+                enum: [scheduled, active, paused, ended, archived]
+              reason:
+                type: string
+    responses:
+      '200':
+        description: 更新成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  $ref: '../components/schemas/_index.yaml#/ActivityInfo'
+
+activityStats:
+  get:
+    tags:
+      - Activities
+    summary: 获取活动统计
+    operationId: getActivityStats
+    parameters:
+      - name: activityId
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: startDate
+        in: query
+        schema:
+          type: string
+          format: date
+      - name: endDate
+        in: query
+        schema:
+          type: string
+          format: date
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  $ref: '../components/schemas/_index.yaml#/ActivityStats'

package/openapi/src/paths/audit.yaml

@@ -0,0 +1,159 @@
+# Audit 审计日志 API
+
+audit:
+  get:
+    tags:
+      - Audit
+    summary: 查询审计日志
+    operationId: listAuditLogs
+    parameters:
+      - name: pageSize
+        in: query
+        schema:
+          type: integer
+          default: 50
+      - name: pageToken
+        in: query
+        schema:
+          type: string
+      - name: actor
+        in: query
+        description: 操作者 ID
+        schema:
+          type: string
+      - name: action
+        in: query
+        description: 操作类型
+        schema:
+          type: string
+          enum:
+            - page.publish
+            - page.rollback
+            - page.delete
+            - component.block
+            - component.deprecated
+            - definition.publish
+            - activity.create
+            - activity.update
+            - rollout.update
+            - kill_switch.enable
+            - kill_switch.disable
+      - name: targetType
+        in: query
+        description: 目标类型
+        schema:
+          type: string
+          enum: [page, component, activity, definition, rollout, kill_switch]
+      - name: targetId
+        in: query
+        description: 目标 ID
+        schema:
+          type: string
+      - name: traceId
+        in: query
+        description: 链路追踪 ID
+        schema:
+          type: string
+      - name: startTime
+        in: query
+        description: 开始时间
+        schema:
+          type: string
+          format: date-time
+      - name: endTime
+        in: query
+        description: 结束时间
+        schema:
+          type: string
+          format: date-time
+      - name: riskLevel
+        in: query
+        description: 风险级别
+        schema:
+          type: string
+          enum: [low, medium, high, critical]
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  type: array
+                  items:
+                    $ref: '../components/schemas/_index.yaml#/AuditLogEntry'
+                meta:
+                  $ref: '../components/schemas/_index.yaml#/PaginationMeta'
+      '401':
+        $ref: '../components/responses/_index.yaml#/Unauthorized'
+      '403':
+        $ref: '../components/responses/_index.yaml#/Forbidden'
+
+auditById:
+  get:
+    tags:
+      - Audit
+    summary: 获取审计日志详情
+    operationId: getAuditLog
+    parameters:
+      - name: auditId
+        in: path
+        required: true
+        schema:
+          type: string
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  $ref: '../components/schemas/_index.yaml#/AuditLogDetail'
+      '404':
+        $ref: '../components/responses/_index.yaml#/NotFound'
+
+auditStats:
+  get:
+    tags:
+      - Audit
+    summary: 获取审计统计
+    operationId: getAuditStats
+    parameters:
+      - name: startDate
+        in: query
+        required: true
+        schema:
+          type: string
+          format: date
+      - name: endDate
+        in: query
+        required: true
+        schema:
+          type: string
+          format: date
+      - name: groupBy
+        in: query
+        schema:
+          type: string
+          enum: [action, actor, targetType, riskLevel]
+          default: action
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  $ref: '../components/schemas/_index.yaml#/AuditStats'

package/openapi/src/paths/components.yaml

@@ -0,0 +1,88 @@
+# 组件管理相关路径
+
+components:
+  get:
+    tags: [Components]
+    operationId: listComponents
+    summary: 获取组件列表
+    description: 获取平台中所有可用的组件
+    parameters:
+      - $ref: '../components/parameters/_index.yaml#/PageParam'
+      - $ref: '../components/parameters/_index.yaml#/LimitParam'
+      - name: category
+        in: query
+        schema:
+          type: string
+        description: 按分类筛选
+      - name: status
+        in: query
+        schema:
+          type: string
+          enum: [active, deprecated, disabled]
+        description: 按状态筛选
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              $ref: '../components/schemas/_index.yaml#/ComponentListResponse'
+      '401':
+        $ref: '../components/responses/_index.yaml#/Unauthorized'
+      '500':
+        $ref: '../components/responses/_index.yaml#/InternalError'
+
+componentVersions:
+  get:
+    tags: [Components]
+    operationId: listComponentVersions
+    summary: 获取组件版本列表
+    description: 获取指定组件的所有版本
+    parameters:
+      - $ref: '../components/parameters/_index.yaml#/ComponentIdPath'
+      - $ref: '../components/parameters/_index.yaml#/PageParam'
+      - $ref: '../components/parameters/_index.yaml#/LimitParam'
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              $ref: '../components/schemas/_index.yaml#/ComponentVersionListResponse'
+      '401':
+        $ref: '../components/responses/_index.yaml#/Unauthorized'
+      '404':
+        $ref: '../components/responses/_index.yaml#/NotFound'
+      '500':
+        $ref: '../components/responses/_index.yaml#/InternalError'
+
+componentVersionStatus:
+  put:
+    tags: [Components]
+    operationId: updateComponentVersionStatus
+    summary: 更新组件版本状态
+    description: 更新指定组件版本的状态（启用/禁用/废弃）
+    parameters:
+      - $ref: '../components/parameters/_index.yaml#/ComponentIdPath'
+      - $ref: '../components/parameters/_index.yaml#/VersionIdPath'
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: '../components/schemas/_index.yaml#/UpdateComponentStatusRequest'
+    responses:
+      '200':
+        description: 更新成功
+        content:
+          application/json:
+            schema:
+              $ref: '../components/schemas/_index.yaml#/ComponentVersionResponse'
+      '400':
+        $ref: '../components/responses/_index.yaml#/BadRequest'
+      '401':
+        $ref: '../components/responses/_index.yaml#/Unauthorized'
+      '404':
+        $ref: '../components/responses/_index.yaml#/NotFound'
+      '500':
+        $ref: '../components/responses/_index.yaml#/InternalError'