@djvlc/openapi-admin-client 1.6.15 → 1.6.16

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.
@@ -8,7 +8,7 @@ components:
8
8
  description: 获取平台中所有可用的组件
9
9
  parameters:
10
10
  - $ref: '../components/parameters/_index.yaml#/PageParam'
11
- - $ref: '../components/parameters/_index.yaml#/LimitParam'
11
+ - $ref: '../components/parameters/_index.yaml#/PageSizeParam'
12
12
  - name: category
13
13
  in: query
14
14
  schema:
@@ -41,7 +41,7 @@ componentVersions:
41
41
  parameters:
42
42
  - $ref: '../components/parameters/_index.yaml#/ComponentIdPath'
43
43
  - $ref: '../components/parameters/_index.yaml#/PageParam'
44
- - $ref: '../components/parameters/_index.yaml#/LimitParam'
44
+ - $ref: '../components/parameters/_index.yaml#/PageSizeParam'
45
45
  responses:
46
46
  '200':
47
47
  description: 成功
@@ -30,6 +30,8 @@ save:
30
30
  description: 保存页面草稿,支持增量保存
31
31
  parameters:
32
32
  - $ref: '../components/parameters/_index.yaml#/PageIdPath'
33
+ - $ref: '../components/parameters/_index.yaml#/IdempotencyKeyHeader'
34
+ - $ref: '../components/parameters/_index.yaml#/XTraceIdHeader'
33
35
  requestBody:
34
36
  required: true
35
37
  content:
@@ -62,6 +64,8 @@ discard:
62
64
  description: 丢弃当前草稿,恢复到最后发布的版本
63
65
  parameters:
64
66
  - $ref: '../components/parameters/_index.yaml#/PageIdPath'
67
+ - $ref: '../components/parameters/_index.yaml#/IdempotencyKeyHeader'
68
+ - $ref: '../components/parameters/_index.yaml#/XTraceIdHeader'
65
69
  requestBody:
66
70
  content:
67
71
  application/json:
@@ -8,7 +8,7 @@ pages:
8
8
  description: 分页获取所有页面的基本信息
9
9
  parameters:
10
10
  - $ref: '../components/parameters/_index.yaml#/PageParam'
11
- - $ref: '../components/parameters/_index.yaml#/LimitParam'
11
+ - $ref: '../components/parameters/_index.yaml#/PageSizeParam'
12
12
  - name: status
13
13
  in: query
14
14
  schema:
@@ -38,6 +38,9 @@ create:
38
38
  operationId: createPage
39
39
  summary: 创建新页面
40
40
  description: 创建一个新的页面,返回页面 ID
41
+ parameters:
42
+ - $ref: '../components/parameters/_index.yaml#/IdempotencyKeyHeader'
43
+ - $ref: '../components/parameters/_index.yaml#/XTraceIdHeader'
41
44
  requestBody:
42
45
  required: true
43
46
  content:
@@ -88,6 +91,8 @@ update:
88
91
  description: 更新页面的元数据(不包括页面内容)
89
92
  parameters:
90
93
  - $ref: '../components/parameters/_index.yaml#/PageIdPath'
94
+ - $ref: '../components/parameters/_index.yaml#/IdempotencyKeyHeader'
95
+ - $ref: '../components/parameters/_index.yaml#/XTraceIdHeader'
91
96
  requestBody:
92
97
  required: true
93
98
  content:
@@ -118,6 +123,8 @@ delete:
118
123
  description: 软删除页面(可恢复)
119
124
  parameters:
120
125
  - $ref: '../components/parameters/_index.yaml#/PageIdPath'
126
+ - $ref: '../components/parameters/_index.yaml#/IdempotencyKeyHeader'
127
+ - $ref: '../components/parameters/_index.yaml#/XTraceIdHeader'
121
128
  requestBody:
122
129
  content:
123
130
  application/json:
@@ -155,6 +162,9 @@ pages/batch/delete:
155
162
  operationId: batchDeletePages
156
163
  summary: 批量删除页面
157
164
  description: 批量软删除页面(可恢复)
165
+ parameters:
166
+ - $ref: '../components/parameters/_index.yaml#/IdempotencyKeyHeader'
167
+ - $ref: '../components/parameters/_index.yaml#/XTraceIdHeader'
158
168
  requestBody:
159
169
  required: true
160
170
  content:
@@ -222,6 +232,8 @@ pages/{pageId}/schema:
222
232
  description: 更新页面的 Schema(编辑器自动保存)
223
233
  parameters:
224
234
  - $ref: '../components/parameters/_index.yaml#/PageIdPath'
235
+ - $ref: '../components/parameters/_index.yaml#/IdempotencyKeyHeader'
236
+ - $ref: '../components/parameters/_index.yaml#/XTraceIdHeader'
225
237
  requestBody:
226
238
  required: true
227
239
  content:
@@ -259,6 +271,8 @@ pages/{pageId}/publish:
259
271
  5. Worker 消费 Outbox,投影写入 Query Tables + CDN
260
272
  parameters:
261
273
  - $ref: '../components/parameters/_index.yaml#/PageIdPath'
274
+ - $ref: '../components/parameters/_index.yaml#/IdempotencyKeyHeader'
275
+ - $ref: '../components/parameters/_index.yaml#/XTraceIdHeader'
262
276
  requestBody:
263
277
  required: true
264
278
  content:
@@ -295,6 +309,8 @@ pages/{pageId}/rollback:
295
309
  3. 写入 Outbox 事件
296
310
  parameters:
297
311
  - $ref: '../components/parameters/_index.yaml#/PageIdPath'
312
+ - $ref: '../components/parameters/_index.yaml#/IdempotencyKeyHeader'
313
+ - $ref: '../components/parameters/_index.yaml#/XTraceIdHeader'
298
314
  requestBody:
299
315
  required: true
300
316
  content:
@@ -326,6 +342,8 @@ pages/{pageId}/duplicate:
326
342
  description: 复制一个页面,生成新的页面副本
327
343
  parameters:
328
344
  - $ref: '../components/parameters/_index.yaml#/PageIdPath'
345
+ - $ref: '../components/parameters/_index.yaml#/IdempotencyKeyHeader'
346
+ - $ref: '../components/parameters/_index.yaml#/XTraceIdHeader'
329
347
  responses:
330
348
  '200':
331
349
  description: 复制成功
@@ -411,6 +429,8 @@ pages/{pageId}/archive:
411
429
  description: 将页面归档,归档后页面不可编辑和发布
412
430
  parameters:
413
431
  - $ref: '../components/parameters/_index.yaml#/PageIdPath'
432
+ - $ref: '../components/parameters/_index.yaml#/IdempotencyKeyHeader'
433
+ - $ref: '../components/parameters/_index.yaml#/XTraceIdHeader'
414
434
  responses:
415
435
  '200':
416
436
  description: 归档成功
@@ -431,6 +451,8 @@ pages/{pageId}/restore:
431
451
  description: 将已归档的页面恢复为正常状态
432
452
  parameters:
433
453
  - $ref: '../components/parameters/_index.yaml#/PageIdPath'
454
+ - $ref: '../components/parameters/_index.yaml#/IdempotencyKeyHeader'
455
+ - $ref: '../components/parameters/_index.yaml#/XTraceIdHeader'
434
456
  responses:
435
457
  '200':
436
458
  description: 恢复成功
@@ -0,0 +1,164 @@
1
+ # 模板管理相关路径
2
+
3
+ templates:
4
+ get:
5
+ tags: [Templates]
6
+ operationId: listTemplates
7
+ summary: 获取模板列表
8
+ description: 分页获取所有模板
9
+ parameters:
10
+ - $ref: '../components/parameters/_index.yaml#/PageParam'
11
+ - $ref: '../components/parameters/_index.yaml#/PageSizeParam'
12
+ - name: search
13
+ in: query
14
+ schema:
15
+ type: string
16
+ description: 搜索关键词
17
+ - name: tags
18
+ in: query
19
+ schema:
20
+ type: array
21
+ items:
22
+ type: string
23
+ description: 按标签筛选
24
+ responses:
25
+ '200':
26
+ description: 成功
27
+ content:
28
+ application/json:
29
+ schema:
30
+ $ref: '../components/schemas/_index.yaml#/TemplateListResponse'
31
+ '401':
32
+ $ref: '../components/responses/_index.yaml#/Unauthorized'
33
+ '500':
34
+ $ref: '../components/responses/_index.yaml#/InternalError'
35
+
36
+ create:
37
+ post:
38
+ tags: [Templates]
39
+ operationId: createTemplate
40
+ summary: 创建模板
41
+ description: 创建一个新的模板
42
+ parameters:
43
+ - $ref: '../components/parameters/_index.yaml#/IdempotencyKeyHeader'
44
+ - $ref: '../components/parameters/_index.yaml#/XTraceIdHeader'
45
+ requestBody:
46
+ required: true
47
+ content:
48
+ application/json:
49
+ schema:
50
+ $ref: '../components/schemas/_index.yaml#/CreateTemplateRequest'
51
+ responses:
52
+ '200':
53
+ description: 创建成功
54
+ content:
55
+ application/json:
56
+ schema:
57
+ $ref: '../components/schemas/_index.yaml#/TemplateResponse'
58
+ '400':
59
+ $ref: '../components/responses/_index.yaml#/BadRequest'
60
+ '401':
61
+ $ref: '../components/responses/_index.yaml#/Unauthorized'
62
+ '500':
63
+ $ref: '../components/responses/_index.yaml#/InternalError'
64
+
65
+ templates/{templateId}:
66
+ get:
67
+ tags: [Templates]
68
+ operationId: getTemplate
69
+ summary: 获取模板详情
70
+ description: 获取指定模板的详细信息
71
+ parameters:
72
+ - name: templateId
73
+ in: path
74
+ required: true
75
+ schema:
76
+ type: string
77
+ description: 模板 ID
78
+ responses:
79
+ '200':
80
+ description: 成功
81
+ content:
82
+ application/json:
83
+ schema:
84
+ $ref: '../components/schemas/_index.yaml#/TemplateResponse'
85
+ '401':
86
+ $ref: '../components/responses/_index.yaml#/Unauthorized'
87
+ '404':
88
+ $ref: '../components/responses/_index.yaml#/NotFound'
89
+ '500':
90
+ $ref: '../components/responses/_index.yaml#/InternalError'
91
+
92
+ update:
93
+ post:
94
+ tags: [Templates]
95
+ operationId: updateTemplate
96
+ summary: 更新模板
97
+ description: 更新模板信息
98
+ parameters:
99
+ - name: templateId
100
+ in: path
101
+ required: true
102
+ schema:
103
+ type: string
104
+ description: 模板 ID
105
+ - $ref: '../components/parameters/_index.yaml#/IdempotencyKeyHeader'
106
+ - $ref: '../components/parameters/_index.yaml#/XTraceIdHeader'
107
+ requestBody:
108
+ required: true
109
+ content:
110
+ application/json:
111
+ schema:
112
+ $ref: '../components/schemas/_index.yaml#/UpdateTemplateRequest'
113
+ responses:
114
+ '200':
115
+ description: 更新成功
116
+ content:
117
+ application/json:
118
+ schema:
119
+ $ref: '../components/schemas/_index.yaml#/TemplateResponse'
120
+ '400':
121
+ $ref: '../components/responses/_index.yaml#/BadRequest'
122
+ '401':
123
+ $ref: '../components/responses/_index.yaml#/Unauthorized'
124
+ '404':
125
+ $ref: '../components/responses/_index.yaml#/NotFound'
126
+ '500':
127
+ $ref: '../components/responses/_index.yaml#/InternalError'
128
+
129
+ delete:
130
+ post:
131
+ tags: [Templates]
132
+ operationId: deleteTemplate
133
+ summary: 删除模板
134
+ description: 删除指定模板
135
+ parameters:
136
+ - name: templateId
137
+ in: path
138
+ required: true
139
+ schema:
140
+ type: string
141
+ description: 模板 ID
142
+ - $ref: '../components/parameters/_index.yaml#/IdempotencyKeyHeader'
143
+ - $ref: '../components/parameters/_index.yaml#/XTraceIdHeader'
144
+ responses:
145
+ '200':
146
+ description: 删除成功
147
+ content:
148
+ application/json:
149
+ schema:
150
+ allOf:
151
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
152
+ - type: object
153
+ properties:
154
+ data:
155
+ type: object
156
+ properties:
157
+ success:
158
+ type: boolean
159
+ '401':
160
+ $ref: '../components/responses/_index.yaml#/Unauthorized'
161
+ '404':
162
+ $ref: '../components/responses/_index.yaml#/NotFound'
163
+ '500':
164
+ $ref: '../components/responses/_index.yaml#/InternalError'
@@ -9,7 +9,7 @@ versions:
9
9
  parameters:
10
10
  - $ref: '../components/parameters/_index.yaml#/PageIdPath'
11
11
  - $ref: '../components/parameters/_index.yaml#/PageParam'
12
- - $ref: '../components/parameters/_index.yaml#/LimitParam'
12
+ - $ref: '../components/parameters/_index.yaml#/PageSizeParam'
13
13
  responses:
14
14
  '200':
15
15
  description: 成功
@@ -46,65 +46,3 @@ versions/{versionId}:
46
46
  $ref: '../components/responses/_index.yaml#/NotFound'
47
47
  '500':
48
48
  $ref: '../components/responses/_index.yaml#/InternalError'
49
-
50
- publish:
51
- post:
52
- tags: [Versions]
53
- operationId: publishVersion
54
- summary: 发布版本
55
- description: 将当前草稿发布为新版本
56
- parameters:
57
- - $ref: '../components/parameters/_index.yaml#/PageIdPath'
58
- requestBody:
59
- required: true
60
- content:
61
- application/json:
62
- schema:
63
- $ref: '../components/schemas/_index.yaml#/PublishRequest'
64
- responses:
65
- '201':
66
- description: 发布成功
67
- content:
68
- application/json:
69
- schema:
70
- $ref: '../components/schemas/_index.yaml#/PublishResponse'
71
- '400':
72
- $ref: '../components/responses/_index.yaml#/BadRequest'
73
- '401':
74
- $ref: '../components/responses/_index.yaml#/Unauthorized'
75
- '404':
76
- $ref: '../components/responses/_index.yaml#/NotFound'
77
- '409':
78
- $ref: '../components/responses/_index.yaml#/Conflict'
79
- '500':
80
- $ref: '../components/responses/_index.yaml#/InternalError'
81
-
82
- rollback:
83
- post:
84
- tags: [Versions]
85
- operationId: rollbackVersion
86
- summary: 回滚版本
87
- description: 回滚到指定的历史版本
88
- parameters:
89
- - $ref: '../components/parameters/_index.yaml#/PageIdPath'
90
- requestBody:
91
- required: true
92
- content:
93
- application/json:
94
- schema:
95
- $ref: '../components/schemas/_index.yaml#/RollbackRequest'
96
- responses:
97
- '200':
98
- description: 回滚成功
99
- content:
100
- application/json:
101
- schema:
102
- $ref: '../components/schemas/_index.yaml#/PublishResponse'
103
- '400':
104
- $ref: '../components/responses/_index.yaml#/BadRequest'
105
- '401':
106
- $ref: '../components/responses/_index.yaml#/Unauthorized'
107
- '404':
108
- $ref: '../components/responses/_index.yaml#/NotFound'
109
- '500':
110
- $ref: '../components/responses/_index.yaml#/InternalError'
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@djvlc/openapi-admin-client",
3
- "version": "1.6.15",
3
+ "version": "1.6.16",
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.11"
29
+ "@djvlc/openapi-client-core": "1.2.12"
30
30
  },
31
31
  "devDependencies": {
32
32
  "@types/node": "^20.0.0",