@djvlc/openapi-admin-client 1.6.1 → 1.6.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -101,7 +101,9 @@ actionDefinitionById:
101
101
  '404':
102
102
  $ref: '../components/responses/_index.yaml#/NotFound'
103
103
 
104
- put:
104
+
105
+ actionDefinitionUpdate:
106
+ post:
105
107
  tags:
106
108
  - Definitions
107
109
  summary: 更新 ActionDefinition
@@ -134,6 +136,28 @@ actionDefinitionById:
134
136
  $ref: '../components/responses/_index.yaml#/BadRequest'
135
137
  '404':
136
138
  $ref: '../components/responses/_index.yaml#/NotFound'
139
+
140
+
141
+ actionDefinitionDelete:
142
+ post:
143
+ tags:
144
+ - Definitions
145
+ summary: 删除 ActionDefinition
146
+ operationId: deleteActionDefinition
147
+ description: 删除 ActionDefinition(仅 draft 状态可删除)
148
+ parameters:
149
+ - name: definitionId
150
+ in: path
151
+ required: true
152
+ schema:
153
+ type: string
154
+ responses:
155
+ '204':
156
+ description: 删除成功
157
+ '404':
158
+ $ref: '../components/responses/_index.yaml#/NotFound'
159
+ '409':
160
+ $ref: '../components/responses/_index.yaml#/Conflict'
137
161
 
138
162
  actionDefinitionVersions:
139
163
  get:
@@ -156,6 +180,11 @@ actionDefinitionVersions:
156
180
  in: query
157
181
  schema:
158
182
  type: string
183
+ - name: status
184
+ in: query
185
+ schema:
186
+ type: string
187
+ enum: [draft, stable, deprecated, blocked]
159
188
  responses:
160
189
  '200':
161
190
  description: 成功
@@ -178,6 +207,9 @@ actionDefinitionVersions:
178
207
  - Definitions
179
208
  summary: 发布 ActionDefinition 新版本
180
209
  operationId: publishActionDefinitionVersion
210
+ description: |
211
+ 发布新版本,版本一旦发布即不可变。
212
+ 状态机:draft → stable → deprecated → blocked
181
213
  parameters:
182
214
  - name: definitionId
183
215
  in: path
@@ -202,6 +234,10 @@ actionDefinitionVersions:
202
234
  type: boolean
203
235
  data:
204
236
  $ref: '../components/schemas/_index.yaml#/DefinitionVersionInfo'
237
+ '400':
238
+ $ref: '../components/responses/_index.yaml#/BadRequest'
239
+ '404':
240
+ $ref: '../components/responses/_index.yaml#/NotFound'
205
241
 
206
242
  # Data Query Definitions
207
243
  dataQueryDefinitions:
@@ -270,6 +306,10 @@ dataQueryDefinitions:
270
306
  type: boolean
271
307
  data:
272
308
  $ref: '../components/schemas/_index.yaml#/DataQueryDefinitionInfo'
309
+ '400':
310
+ $ref: '../components/responses/_index.yaml#/BadRequest'
311
+ '401':
312
+ $ref: '../components/responses/_index.yaml#/Unauthorized'
273
313
 
274
314
  dataQueryDefinitionById:
275
315
  get:
@@ -297,6 +337,64 @@ dataQueryDefinitionById:
297
337
  $ref: '../components/schemas/_index.yaml#/DataQueryDefinitionDetail'
298
338
  '404':
299
339
  $ref: '../components/responses/_index.yaml#/NotFound'
340
+
341
+
342
+ dataQueryDefinitionUpdate:
343
+ post:
344
+ tags:
345
+ - Definitions
346
+ summary: 更新 DataQueryDefinition
347
+ operationId: updateDataQueryDefinition
348
+ parameters:
349
+ - name: definitionId
350
+ in: path
351
+ required: true
352
+ schema:
353
+ type: string
354
+ requestBody:
355
+ required: true
356
+ content:
357
+ application/json:
358
+ schema:
359
+ $ref: '../components/schemas/_index.yaml#/UpdateDataQueryDefinitionRequest'
360
+ responses:
361
+ '200':
362
+ description: 更新成功
363
+ content:
364
+ application/json:
365
+ schema:
366
+ type: object
367
+ properties:
368
+ success:
369
+ type: boolean
370
+ data:
371
+ $ref: '../components/schemas/_index.yaml#/DataQueryDefinitionInfo'
372
+ '400':
373
+ $ref: '../components/responses/_index.yaml#/BadRequest'
374
+ '404':
375
+ $ref: '../components/responses/_index.yaml#/NotFound'
376
+
377
+
378
+ dataQueryDefinitionDelete:
379
+ post:
380
+ tags:
381
+ - Definitions
382
+ summary: 删除 DataQueryDefinition
383
+ operationId: deleteDataQueryDefinition
384
+ description: 删除 DataQueryDefinition(仅 draft 状态可删除)
385
+ parameters:
386
+ - name: definitionId
387
+ in: path
388
+ required: true
389
+ schema:
390
+ type: string
391
+ responses:
392
+ '204':
393
+ description: 删除成功
394
+ '404':
395
+ $ref: '../components/responses/_index.yaml#/NotFound'
396
+ '409':
397
+ $ref: '../components/responses/_index.yaml#/Conflict'
300
398
 
301
399
  dataQueryDefinitionVersions:
302
400
  get:
@@ -310,6 +408,11 @@ dataQueryDefinitionVersions:
310
408
  required: true
311
409
  schema:
312
410
  type: string
411
+ - name: status
412
+ in: query
413
+ schema:
414
+ type: string
415
+ enum: [draft, stable, deprecated, blocked]
313
416
  responses:
314
417
  '200':
315
418
  description: 成功
@@ -330,6 +433,9 @@ dataQueryDefinitionVersions:
330
433
  - Definitions
331
434
  summary: 发布 DataQueryDefinition 新版本
332
435
  operationId: publishDataQueryDefinitionVersion
436
+ description: |
437
+ 发布新版本,版本一旦发布即不可变。
438
+ 状态机:draft → stable → deprecated → blocked
333
439
  parameters:
334
440
  - name: definitionId
335
441
  in: path
@@ -354,3 +460,7 @@ dataQueryDefinitionVersions:
354
460
  type: boolean
355
461
  data:
356
462
  $ref: '../components/schemas/_index.yaml#/DefinitionVersionInfo'
463
+ '400':
464
+ $ref: '../components/responses/_index.yaml#/BadRequest'
465
+ '404':
466
+ $ref: '../components/responses/_index.yaml#/NotFound'
@@ -22,7 +22,8 @@ draft:
22
22
  '500':
23
23
  $ref: '../components/responses/_index.yaml#/InternalError'
24
24
 
25
- put:
25
+ save:
26
+ post:
26
27
  tags: [Drafts]
27
28
  operationId: saveDraft
28
29
  summary: 保存草稿
@@ -53,16 +54,35 @@ draft:
53
54
  '500':
54
55
  $ref: '../components/responses/_index.yaml#/InternalError'
55
56
 
56
- delete:
57
+ discard:
58
+ post:
57
59
  tags: [Drafts]
58
60
  operationId: discardDraft
59
61
  summary: 丢弃草稿
60
62
  description: 丢弃当前草稿,恢复到最后发布的版本
61
63
  parameters:
62
64
  - $ref: '../components/parameters/_index.yaml#/PageIdPath'
65
+ requestBody:
66
+ content:
67
+ application/json:
68
+ schema:
69
+ type: object
70
+ properties:
71
+ reason:
72
+ type: string
73
+ description: 丢弃原因
63
74
  responses:
64
- '204':
75
+ '200':
65
76
  description: 丢弃成功
77
+ content:
78
+ application/json:
79
+ schema:
80
+ type: object
81
+ properties:
82
+ success:
83
+ type: boolean
84
+ message:
85
+ type: string
66
86
  '401':
67
87
  $ref: '../components/responses/_index.yaml#/Unauthorized'
68
88
  '404':
@@ -0,0 +1,88 @@
1
+ # Health 健康检查 API
2
+
3
+ health:
4
+ get:
5
+ tags:
6
+ - Health
7
+ summary: 健康检查
8
+ operationId: healthCheck
9
+ description: |
10
+ 综合健康检查,包含所有依赖服务状态。
11
+
12
+ 返回:
13
+ - 服务状态(healthy/degraded/unhealthy)
14
+ - 版本信息
15
+ - 运行时间
16
+ - 依赖服务状态
17
+ responses:
18
+ '200':
19
+ description: 服务健康
20
+ content:
21
+ application/json:
22
+ schema:
23
+ $ref: '../components/schemas/_index.yaml#/HealthResponse'
24
+ '503':
25
+ description: 服务不健康
26
+ content:
27
+ application/json:
28
+ schema:
29
+ $ref: '../components/schemas/_index.yaml#/HealthResponse'
30
+ security: []
31
+
32
+ ready:
33
+ get:
34
+ tags:
35
+ - Health
36
+ summary: 就绪检查
37
+ operationId: readinessCheck
38
+ description: |
39
+ Kubernetes readiness probe。
40
+ 检查服务是否准备好接收流量。
41
+ responses:
42
+ '200':
43
+ description: 服务就绪
44
+ content:
45
+ application/json:
46
+ schema:
47
+ type: object
48
+ properties:
49
+ ready:
50
+ type: boolean
51
+ example: true
52
+ '503':
53
+ description: 服务未就绪
54
+ content:
55
+ application/json:
56
+ schema:
57
+ type: object
58
+ properties:
59
+ ready:
60
+ type: boolean
61
+ example: false
62
+ reason:
63
+ type: string
64
+ security: []
65
+
66
+ live:
67
+ get:
68
+ tags:
69
+ - Health
70
+ summary: 存活检查
71
+ operationId: livenessCheck
72
+ description: |
73
+ Kubernetes liveness probe。
74
+ 检查服务是否存活。
75
+ responses:
76
+ '200':
77
+ description: 服务存活
78
+ content:
79
+ application/json:
80
+ schema:
81
+ type: object
82
+ properties:
83
+ alive:
84
+ type: boolean
85
+ example: true
86
+ '503':
87
+ description: 服务不存活
88
+ security: []
@@ -18,7 +18,8 @@ killSwitch:
18
18
  '500':
19
19
  $ref: '../components/responses/_index.yaml#/InternalError'
20
20
 
21
- put:
21
+ killSwitchSet:
22
+ post:
22
23
  tags: [Operations]
23
24
  operationId: setGlobalKillSwitch
24
25
  summary: 设置全局 Kill Switch
@@ -67,7 +68,8 @@ killSwitchPage:
67
68
  '500':
68
69
  $ref: '../components/responses/_index.yaml#/InternalError'
69
70
 
70
- put:
71
+ killSwitchPageSet:
72
+ post:
71
73
  tags: [Operations]
72
74
  operationId: setPageKillSwitch
73
75
  summary: 设置页面 Kill Switch
@@ -32,6 +32,7 @@ pages:
32
32
  '500':
33
33
  $ref: '../components/responses/_index.yaml#/InternalError'
34
34
 
35
+ create:
35
36
  post:
36
37
  tags: [Pages]
37
38
  operationId: createPage
@@ -44,7 +45,7 @@ pages:
44
45
  schema:
45
46
  $ref: '../components/schemas/_index.yaml#/CreatePageRequest'
46
47
  responses:
47
- '201':
48
+ '200':
48
49
  description: 创建成功
49
50
  content:
50
51
  application/json:
@@ -79,7 +80,8 @@ pages/{pageId}:
79
80
  '500':
80
81
  $ref: '../components/responses/_index.yaml#/InternalError'
81
82
 
82
- put:
83
+ update:
84
+ post:
83
85
  tags: [Pages]
84
86
  operationId: updatePage
85
87
  summary: 更新页面信息
@@ -108,16 +110,35 @@ pages/{pageId}:
108
110
  '500':
109
111
  $ref: '../components/responses/_index.yaml#/InternalError'
110
112
 
111
- delete:
113
+ delete:
114
+ post:
112
115
  tags: [Pages]
113
116
  operationId: deletePage
114
117
  summary: 删除页面
115
118
  description: 软删除页面(可恢复)
116
119
  parameters:
117
120
  - $ref: '../components/parameters/_index.yaml#/PageIdPath'
121
+ requestBody:
122
+ content:
123
+ application/json:
124
+ schema:
125
+ type: object
126
+ properties:
127
+ reason:
128
+ type: string
129
+ description: 删除原因
118
130
  responses:
119
- '204':
131
+ '200':
120
132
  description: 删除成功
133
+ content:
134
+ application/json:
135
+ schema:
136
+ type: object
137
+ properties:
138
+ success:
139
+ type: boolean
140
+ message:
141
+ type: string
121
142
  '401':
122
143
  $ref: '../components/responses/_index.yaml#/Unauthorized'
123
144
  '404':
@@ -0,0 +1,146 @@
1
+ # Preview 预览 API
2
+
3
+ preview:
4
+ post:
5
+ tags:
6
+ - Preview
7
+ summary: 生成预览 Token
8
+ operationId: createPreviewToken
9
+ description: |
10
+ 为当前草稿生成预览 Token。
11
+
12
+ 特点:
13
+ - Token 有效期短(默认 30 分钟)
14
+ - 预览使用 Runtime 渲染(确保"预览即线上")
15
+ - 可配置预览设备类型
16
+ parameters:
17
+ - $ref: '../components/parameters/_index.yaml#/PageIdPath'
18
+ requestBody:
19
+ content:
20
+ application/json:
21
+ schema:
22
+ type: object
23
+ properties:
24
+ expiresIn:
25
+ type: integer
26
+ minimum: 60
27
+ maximum: 86400
28
+ default: 1800
29
+ description: 过期时间(秒),默认 30 分钟
30
+ deviceType:
31
+ type: string
32
+ enum: [mobile, tablet, desktop]
33
+ description: 预览设备类型
34
+ context:
35
+ type: object
36
+ additionalProperties: true
37
+ description: 预览上下文数据
38
+ responses:
39
+ '201':
40
+ description: 创建成功
41
+ content:
42
+ application/json:
43
+ schema:
44
+ type: object
45
+ properties:
46
+ success:
47
+ type: boolean
48
+ data:
49
+ $ref: '../components/schemas/_index.yaml#/PreviewTokenInfo'
50
+ '400':
51
+ $ref: '../components/responses/_index.yaml#/BadRequest'
52
+ '401':
53
+ $ref: '../components/responses/_index.yaml#/Unauthorized'
54
+ '404':
55
+ $ref: '../components/responses/_index.yaml#/NotFound'
56
+
57
+ previewToken:
58
+ get:
59
+ tags:
60
+ - Preview
61
+ summary: 获取预览 Token 信息
62
+ operationId: getPreviewToken
63
+ description: 获取指定预览 Token 的详细信息
64
+ parameters:
65
+ - name: token
66
+ in: path
67
+ required: true
68
+ schema:
69
+ type: string
70
+ description: 预览 Token
71
+ responses:
72
+ '200':
73
+ description: 成功
74
+ content:
75
+ application/json:
76
+ schema:
77
+ type: object
78
+ properties:
79
+ success:
80
+ type: boolean
81
+ data:
82
+ $ref: '../components/schemas/_index.yaml#/PreviewTokenInfo'
83
+ '404':
84
+ $ref: '../components/responses/_index.yaml#/NotFound'
85
+
86
+ previewTokenRevoke:
87
+ post:
88
+ tags:
89
+ - Preview
90
+ summary: 撤销预览 Token
91
+ operationId: revokePreviewToken
92
+ description: 撤销指定的预览 Token
93
+ parameters:
94
+ - name: token
95
+ in: path
96
+ required: true
97
+ schema:
98
+ type: string
99
+ description: 预览 Token
100
+ requestBody:
101
+ content:
102
+ application/json:
103
+ schema:
104
+ type: object
105
+ properties:
106
+ reason:
107
+ type: string
108
+ description: 撤销原因
109
+ responses:
110
+ '200':
111
+ description: 撤销成功
112
+ content:
113
+ application/json:
114
+ schema:
115
+ type: object
116
+ properties:
117
+ success:
118
+ type: boolean
119
+ message:
120
+ type: string
121
+ '404':
122
+ $ref: '../components/responses/_index.yaml#/NotFound'
123
+
124
+ previewList:
125
+ get:
126
+ tags:
127
+ - Preview
128
+ summary: 获取预览 Token 列表
129
+ operationId: listPreviewTokens
130
+ description: 获取指定页面的所有有效预览 Token
131
+ parameters:
132
+ - $ref: '../components/parameters/_index.yaml#/PageIdPath'
133
+ responses:
134
+ '200':
135
+ description: 成功
136
+ content:
137
+ application/json:
138
+ schema:
139
+ type: object
140
+ properties:
141
+ success:
142
+ type: boolean
143
+ data:
144
+ type: array
145
+ items:
146
+ $ref: '../components/schemas/_index.yaml#/PreviewTokenInfo'
@@ -26,8 +26,9 @@ rollout:
26
26
  $ref: '../components/schemas/_index.yaml#/RolloutConfig'
27
27
  '404':
28
28
  $ref: '../components/responses/_index.yaml#/NotFound'
29
-
30
- put:
29
+
30
+ rolloutUpdate:
31
+ post:
31
32
  tags:
32
33
  - Rollout
33
34
  summary: 更新页面灰度配置
@@ -60,21 +61,41 @@ rollout:
60
61
  $ref: '../components/responses/_index.yaml#/BadRequest'
61
62
  '404':
62
63
  $ref: '../components/responses/_index.yaml#/NotFound'
63
-
64
- delete:
64
+
65
+ rolloutRemove:
66
+ post:
65
67
  tags:
66
68
  - Rollout
67
- summary: 删除页面灰度配置(使用默认版本)
68
- operationId: deleteRolloutConfig
69
+ summary: 删除页面灰度配置
70
+ operationId: removeRolloutConfig
71
+ description: 删除页面灰度配置(使用默认版本)
69
72
  parameters:
70
73
  - name: pageId
71
74
  in: path
72
75
  required: true
73
76
  schema:
74
77
  type: string
78
+ requestBody:
79
+ content:
80
+ application/json:
81
+ schema:
82
+ type: object
83
+ properties:
84
+ reason:
85
+ type: string
86
+ description: 删除原因
75
87
  responses:
76
- '204':
88
+ '200':
77
89
  description: 删除成功
90
+ content:
91
+ application/json:
92
+ schema:
93
+ type: object
94
+ properties:
95
+ success:
96
+ type: boolean
97
+ message:
98
+ type: string
78
99
  '404':
79
100
  $ref: '../components/responses/_index.yaml#/NotFound'
80
101
 
@@ -97,7 +118,7 @@ rolloutStrategies:
97
118
  schema:
98
119
  $ref: '../components/schemas/_index.yaml#/AddRolloutStrategyRequest'
99
120
  responses:
100
- '201':
121
+ '200':
101
122
  description: 添加成功
102
123
  content:
103
124
  application/json:
@@ -109,8 +130,8 @@ rolloutStrategies:
109
130
  data:
110
131
  $ref: '../components/schemas/_index.yaml#/RolloutStrategy'
111
132
 
112
- rolloutStrategyById:
113
- put:
133
+ rolloutStrategyUpdate:
134
+ post:
114
135
  tags:
115
136
  - Rollout
116
137
  summary: 更新灰度策略
@@ -144,12 +165,13 @@ rolloutStrategyById:
144
165
  type: boolean
145
166
  data:
146
167
  $ref: '../components/schemas/_index.yaml#/RolloutStrategy'
147
-
148
- delete:
168
+
169
+ rolloutStrategyRemove:
170
+ post:
149
171
  tags:
150
172
  - Rollout
151
173
  summary: 删除灰度策略
152
- operationId: deleteRolloutStrategy
174
+ operationId: removeRolloutStrategy
153
175
  parameters:
154
176
  - name: pageId
155
177
  in: path
@@ -161,6 +183,24 @@ rolloutStrategyById:
161
183
  required: true
162
184
  schema:
163
185
  type: string
186
+ requestBody:
187
+ content:
188
+ application/json:
189
+ schema:
190
+ type: object
191
+ properties:
192
+ reason:
193
+ type: string
194
+ description: 删除原因
164
195
  responses:
165
- '204':
196
+ '200':
166
197
  description: 删除成功
198
+ content:
199
+ application/json:
200
+ schema:
201
+ type: object
202
+ properties:
203
+ success:
204
+ type: boolean
205
+ message:
206
+ type: string
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@djvlc/openapi-admin-client",
3
- "version": "1.6.1",
3
+ "version": "1.6.3",
4
4
  "description": "DJV Low-code Platform - Admin API 客户端(自动生成)",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",
@@ -26,7 +26,7 @@
26
26
  "generate": "openapi-generator-cli generate -i openapi/admin-api.yaml -g typescript-fetch -o src/generated --additional-properties=supportsES6=true,typescriptThreePlus=true"
27
27
  },
28
28
  "dependencies": {
29
- "@djvlc/openapi-client-core": "1.2.0"
29
+ "@djvlc/openapi-client-core": "1.2.1"
30
30
  },
31
31
  "devDependencies": {
32
32
  "@types/node": "^20.0.0",