@djvlc/openapi-admin-client 1.5.0 → 1.6.1

package/openapi/src/paths/definitions.yaml

@@ -0,0 +1,356 @@
+# Definition 管理 API
+
+# Action Definitions
+actionDefinitions:
+  get:
+    tags:
+      - Definitions
+    summary: 获取 ActionDefinition 列表
+    operationId: listActionDefinitions
+    parameters:
+      - name: pageSize
+        in: query
+        schema:
+          type: integer
+          default: 20
+      - name: pageToken
+        in: query
+        schema:
+          type: string
+      - name: actionType
+        in: query
+        schema:
+          type: string
+          enum: [claim, signin, lottery, reserve, bind, task_complete, vote, share, form_submit, custom]
+      - name: status
+        in: query
+        schema:
+          type: string
+          enum: [draft, stable, deprecated, blocked]
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  type: array
+                  items:
+                    $ref: '../components/schemas/_index.yaml#/ActionDefinitionInfo'
+                meta:
+                  $ref: '../components/schemas/_index.yaml#/PaginationMeta'
+      '401':
+        $ref: '../components/responses/_index.yaml#/Unauthorized'
+  
+  post:
+    tags:
+      - Definitions
+    summary: 创建 ActionDefinition
+    operationId: createActionDefinition
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: '../components/schemas/_index.yaml#/CreateActionDefinitionRequest'
+    responses:
+      '201':
+        description: 创建成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  $ref: '../components/schemas/_index.yaml#/ActionDefinitionInfo'
+      '400':
+        $ref: '../components/responses/_index.yaml#/BadRequest'
+      '401':
+        $ref: '../components/responses/_index.yaml#/Unauthorized'
+
+actionDefinitionById:
+  get:
+    tags:
+      - Definitions
+    summary: 获取 ActionDefinition 详情
+    operationId: getActionDefinition
+    parameters:
+      - name: definitionId
+        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#/ActionDefinitionDetail'
+      '404':
+        $ref: '../components/responses/_index.yaml#/NotFound'
+  
+  put:
+    tags:
+      - Definitions
+    summary: 更新 ActionDefinition
+    operationId: updateActionDefinition
+    parameters:
+      - name: definitionId
+        in: path
+        required: true
+        schema:
+          type: string
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: '../components/schemas/_index.yaml#/UpdateActionDefinitionRequest'
+    responses:
+      '200':
+        description: 更新成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  $ref: '../components/schemas/_index.yaml#/ActionDefinitionInfo'
+      '400':
+        $ref: '../components/responses/_index.yaml#/BadRequest'
+      '404':
+        $ref: '../components/responses/_index.yaml#/NotFound'
+
+actionDefinitionVersions:
+  get:
+    tags:
+      - Definitions
+    summary: 获取 ActionDefinition 版本列表
+    operationId: listActionDefinitionVersions
+    parameters:
+      - name: definitionId
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: pageSize
+        in: query
+        schema:
+          type: integer
+          default: 20
+      - name: pageToken
+        in: query
+        schema:
+          type: string
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  type: array
+                  items:
+                    $ref: '../components/schemas/_index.yaml#/DefinitionVersionInfo'
+                meta:
+                  $ref: '../components/schemas/_index.yaml#/PaginationMeta'
+  
+  post:
+    tags:
+      - Definitions
+    summary: 发布 ActionDefinition 新版本
+    operationId: publishActionDefinitionVersion
+    parameters:
+      - name: definitionId
+        in: path
+        required: true
+        schema:
+          type: string
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: '../components/schemas/_index.yaml#/PublishDefinitionVersionRequest'
+    responses:
+      '201':
+        description: 发布成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  $ref: '../components/schemas/_index.yaml#/DefinitionVersionInfo'
+
+# Data Query Definitions
+dataQueryDefinitions:
+  get:
+    tags:
+      - Definitions
+    summary: 获取 DataQueryDefinition 列表
+    operationId: listDataQueryDefinitions
+    parameters:
+      - name: pageSize
+        in: query
+        schema:
+          type: integer
+          default: 20
+      - name: pageToken
+        in: query
+        schema:
+          type: string
+      - name: sourceType
+        in: query
+        schema:
+          type: string
+          enum: [http, graphql, database, internal, aggregation]
+      - name: status
+        in: query
+        schema:
+          type: string
+          enum: [draft, stable, deprecated, blocked]
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  type: array
+                  items:
+                    $ref: '../components/schemas/_index.yaml#/DataQueryDefinitionInfo'
+                meta:
+                  $ref: '../components/schemas/_index.yaml#/PaginationMeta'
+  
+  post:
+    tags:
+      - Definitions
+    summary: 创建 DataQueryDefinition
+    operationId: createDataQueryDefinition
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: '../components/schemas/_index.yaml#/CreateDataQueryDefinitionRequest'
+    responses:
+      '201':
+        description: 创建成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  $ref: '../components/schemas/_index.yaml#/DataQueryDefinitionInfo'
+
+dataQueryDefinitionById:
+  get:
+    tags:
+      - Definitions
+    summary: 获取 DataQueryDefinition 详情
+    operationId: getDataQueryDefinition
+    parameters:
+      - name: definitionId
+        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#/DataQueryDefinitionDetail'
+      '404':
+        $ref: '../components/responses/_index.yaml#/NotFound'
+
+dataQueryDefinitionVersions:
+  get:
+    tags:
+      - Definitions
+    summary: 获取 DataQueryDefinition 版本列表
+    operationId: listDataQueryDefinitionVersions
+    parameters:
+      - name: definitionId
+        in: path
+        required: true
+        schema:
+          type: string
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  type: array
+                  items:
+                    $ref: '../components/schemas/_index.yaml#/DefinitionVersionInfo'
+  
+  post:
+    tags:
+      - Definitions
+    summary: 发布 DataQueryDefinition 新版本
+    operationId: publishDataQueryDefinitionVersion
+    parameters:
+      - name: definitionId
+        in: path
+        required: true
+        schema:
+          type: string
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: '../components/schemas/_index.yaml#/PublishDefinitionVersionRequest'
+    responses:
+      '201':
+        description: 发布成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  $ref: '../components/schemas/_index.yaml#/DefinitionVersionInfo'

package/openapi/src/paths/drafts.yaml

@@ -0,0 +1,71 @@
+# 草稿管理相关路径
+
+draft:
+  get:
+    tags: [Drafts]
+    operationId: getDraft
+    summary: 获取页面草稿
+    description: 获取指定页面的当前草稿内容
+    parameters:
+      - $ref: '../components/parameters/_index.yaml#/PageIdPath'
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              $ref: '../components/schemas/_index.yaml#/DraftResponse'
+      '401':
+        $ref: '../components/responses/_index.yaml#/Unauthorized'
+      '404':
+        $ref: '../components/responses/_index.yaml#/NotFound'
+      '500':
+        $ref: '../components/responses/_index.yaml#/InternalError'
+
+  put:
+    tags: [Drafts]
+    operationId: saveDraft
+    summary: 保存草稿
+    description: 保存页面草稿，支持增量保存
+    parameters:
+      - $ref: '../components/parameters/_index.yaml#/PageIdPath'
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: '../components/schemas/_index.yaml#/SaveDraftRequest'
+    responses:
+      '200':
+        description: 保存成功
+        content:
+          application/json:
+            schema:
+              $ref: '../components/schemas/_index.yaml#/DraftResponse'
+      '400':
+        $ref: '../components/responses/_index.yaml#/BadRequest'
+      '401':
+        $ref: '../components/responses/_index.yaml#/Unauthorized'
+      '404':
+        $ref: '../components/responses/_index.yaml#/NotFound'
+      '409':
+        $ref: '../components/responses/_index.yaml#/Conflict'
+      '500':
+        $ref: '../components/responses/_index.yaml#/InternalError'
+
+  delete:
+    tags: [Drafts]
+    operationId: discardDraft
+    summary: 丢弃草稿
+    description: 丢弃当前草稿，恢复到最后发布的版本
+    parameters:
+      - $ref: '../components/parameters/_index.yaml#/PageIdPath'
+    responses:
+      '204':
+        description: 丢弃成功
+      '401':
+        $ref: '../components/responses/_index.yaml#/Unauthorized'
+      '404':
+        $ref: '../components/responses/_index.yaml#/NotFound'
+      '500':
+        $ref: '../components/responses/_index.yaml#/InternalError'

package/openapi/src/paths/operations.yaml

@@ -0,0 +1,99 @@
+# 运维操作相关路径
+
+killSwitch:
+  get:
+    tags: [Operations]
+    operationId: getKillSwitchStatus
+    summary: 获取 Kill Switch 状态
+    description: 获取全局 Kill Switch 状态
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              $ref: '../components/schemas/_index.yaml#/KillSwitchStatusResponse'
+      '401':
+        $ref: '../components/responses/_index.yaml#/Unauthorized'
+      '500':
+        $ref: '../components/responses/_index.yaml#/InternalError'
+
+  put:
+    tags: [Operations]
+    operationId: setGlobalKillSwitch
+    summary: 设置全局 Kill Switch
+    description: 启用或禁用全局 Kill Switch（紧急停用所有页面）
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: '../components/schemas/_index.yaml#/SetKillSwitchRequest'
+    responses:
+      '200':
+        description: 设置成功
+        content:
+          application/json:
+            schema:
+              $ref: '../components/schemas/_index.yaml#/KillSwitchStatusResponse'
+      '400':
+        $ref: '../components/responses/_index.yaml#/BadRequest'
+      '401':
+        $ref: '../components/responses/_index.yaml#/Unauthorized'
+      '403':
+        $ref: '../components/responses/_index.yaml#/Forbidden'
+      '500':
+        $ref: '../components/responses/_index.yaml#/InternalError'
+
+killSwitchPage:
+  get:
+    tags: [Operations]
+    operationId: getPageKillSwitchStatus
+    summary: 获取页面 Kill Switch 状态
+    description: 获取指定页面的 Kill Switch 状态
+    parameters:
+      - $ref: '../components/parameters/_index.yaml#/PageIdPath'
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              $ref: '../components/schemas/_index.yaml#/PageKillSwitchStatusResponse'
+      '401':
+        $ref: '../components/responses/_index.yaml#/Unauthorized'
+      '404':
+        $ref: '../components/responses/_index.yaml#/NotFound'
+      '500':
+        $ref: '../components/responses/_index.yaml#/InternalError'
+
+  put:
+    tags: [Operations]
+    operationId: setPageKillSwitch
+    summary: 设置页面 Kill Switch
+    description: 启用或禁用指定页面的 Kill Switch
+    parameters:
+      - $ref: '../components/parameters/_index.yaml#/PageIdPath'
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: '../components/schemas/_index.yaml#/SetKillSwitchRequest'
+    responses:
+      '200':
+        description: 设置成功
+        content:
+          application/json:
+            schema:
+              $ref: '../components/schemas/_index.yaml#/PageKillSwitchStatusResponse'
+      '400':
+        $ref: '../components/responses/_index.yaml#/BadRequest'
+      '401':
+        $ref: '../components/responses/_index.yaml#/Unauthorized'
+      '403':
+        $ref: '../components/responses/_index.yaml#/Forbidden'
+      '404':
+        $ref: '../components/responses/_index.yaml#/NotFound'
+      '500':
+        $ref: '../components/responses/_index.yaml#/InternalError'

package/openapi/src/paths/pages.yaml

@@ -0,0 +1,126 @@
+# 页面管理相关路径
+
+pages:
+  get:
+    tags: [Pages]
+    operationId: listPages
+    summary: 获取页面列表
+    description: 分页获取所有页面的基本信息
+    parameters:
+      - $ref: '../components/parameters/_index.yaml#/PageParam'
+      - $ref: '../components/parameters/_index.yaml#/LimitParam'
+      - name: status
+        in: query
+        schema:
+          type: string
+          enum: [draft, published, archived]
+        description: 按状态筛选
+      - name: search
+        in: query
+        schema:
+          type: string
+        description: 搜索关键词
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              $ref: '../components/schemas/_index.yaml#/PageListResponse'
+      '401':
+        $ref: '../components/responses/_index.yaml#/Unauthorized'
+      '500':
+        $ref: '../components/responses/_index.yaml#/InternalError'
+
+  post:
+    tags: [Pages]
+    operationId: createPage
+    summary: 创建新页面
+    description: 创建一个新的页面，返回页面 ID
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: '../components/schemas/_index.yaml#/CreatePageRequest'
+    responses:
+      '201':
+        description: 创建成功
+        content:
+          application/json:
+            schema:
+              $ref: '../components/schemas/_index.yaml#/PageResponse'
+      '400':
+        $ref: '../components/responses/_index.yaml#/BadRequest'
+      '401':
+        $ref: '../components/responses/_index.yaml#/Unauthorized'
+      '500':
+        $ref: '../components/responses/_index.yaml#/InternalError'
+
+pages/{pageId}:
+  get:
+    tags: [Pages]
+    operationId: getPage
+    summary: 获取页面详情
+    description: 获取指定页面的完整信息
+    parameters:
+      - $ref: '../components/parameters/_index.yaml#/PageIdPath'
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              $ref: '../components/schemas/_index.yaml#/PageResponse'
+      '401':
+        $ref: '../components/responses/_index.yaml#/Unauthorized'
+      '404':
+        $ref: '../components/responses/_index.yaml#/NotFound'
+      '500':
+        $ref: '../components/responses/_index.yaml#/InternalError'
+
+  put:
+    tags: [Pages]
+    operationId: updatePage
+    summary: 更新页面信息
+    description: 更新页面的元数据（不包括页面内容）
+    parameters:
+      - $ref: '../components/parameters/_index.yaml#/PageIdPath'
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: '../components/schemas/_index.yaml#/UpdatePageRequest'
+    responses:
+      '200':
+        description: 更新成功
+        content:
+          application/json:
+            schema:
+              $ref: '../components/schemas/_index.yaml#/PageResponse'
+      '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'
+
+  delete:
+    tags: [Pages]
+    operationId: deletePage
+    summary: 删除页面
+    description: 软删除页面（可恢复）
+    parameters:
+      - $ref: '../components/parameters/_index.yaml#/PageIdPath'
+    responses:
+      '204':
+        description: 删除成功
+      '401':
+        $ref: '../components/responses/_index.yaml#/Unauthorized'
+      '404':
+        $ref: '../components/responses/_index.yaml#/NotFound'
+      '500':
+        $ref: '../components/responses/_index.yaml#/InternalError'