@djvlc/openapi-admin-client 1.5.0 → 1.6.0

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.
@@ -0,0 +1,54 @@
1
+ # 参数组件索引
2
+
3
+ # ============================================================================
4
+ # 路径参数
5
+ # ============================================================================
6
+
7
+ PageIdPath:
8
+ name: pageId
9
+ in: path
10
+ required: true
11
+ schema:
12
+ type: string
13
+ minLength: 1
14
+ maxLength: 128
15
+ description: 页面 ID
16
+
17
+ VersionIdPath:
18
+ name: versionId
19
+ in: path
20
+ required: true
21
+ schema:
22
+ type: string
23
+ description: 版本 ID
24
+
25
+ ComponentIdPath:
26
+ name: componentId
27
+ in: path
28
+ required: true
29
+ schema:
30
+ type: string
31
+ description: 组件 ID
32
+
33
+ # ============================================================================
34
+ # 分页参数
35
+ # ============================================================================
36
+
37
+ PageParam:
38
+ name: page
39
+ in: query
40
+ schema:
41
+ type: integer
42
+ minimum: 1
43
+ default: 1
44
+ description: 页码
45
+
46
+ LimitParam:
47
+ name: limit
48
+ in: query
49
+ schema:
50
+ type: integer
51
+ minimum: 1
52
+ maximum: 100
53
+ default: 20
54
+ description: 每页数量
@@ -0,0 +1,65 @@
1
+ # 响应组件索引
2
+
3
+ BadRequest:
4
+ description: 请求参数错误
5
+ content:
6
+ application/json:
7
+ schema:
8
+ $ref: '../schemas/_index.yaml#/ErrorResponse'
9
+ example:
10
+ code: BAD_REQUEST
11
+ message: 请求参数无效
12
+ details:
13
+ - field: title
14
+ message: 标题不能为空
15
+ code: REQUIRED
16
+
17
+ Unauthorized:
18
+ description: 未授权
19
+ content:
20
+ application/json:
21
+ schema:
22
+ $ref: '../schemas/_index.yaml#/ErrorResponse'
23
+ example:
24
+ code: UNAUTHORIZED
25
+ message: 请先登录
26
+
27
+ Forbidden:
28
+ description: 权限不足
29
+ content:
30
+ application/json:
31
+ schema:
32
+ $ref: '../schemas/_index.yaml#/ErrorResponse'
33
+ example:
34
+ code: FORBIDDEN
35
+ message: 您没有权限执行此操作
36
+
37
+ NotFound:
38
+ description: 资源不存在
39
+ content:
40
+ application/json:
41
+ schema:
42
+ $ref: '../schemas/_index.yaml#/ErrorResponse'
43
+ example:
44
+ code: NOT_FOUND
45
+ message: 资源不存在
46
+
47
+ Conflict:
48
+ description: 资源冲突
49
+ content:
50
+ application/json:
51
+ schema:
52
+ $ref: '../schemas/_index.yaml#/ErrorResponse'
53
+ example:
54
+ code: CONFLICT
55
+ message: 资源已被其他用户修改,请刷新后重试
56
+
57
+ InternalError:
58
+ description: 服务器内部错误
59
+ content:
60
+ application/json:
61
+ schema:
62
+ $ref: '../schemas/_index.yaml#/ErrorResponse'
63
+ example:
64
+ code: INTERNAL_ERROR
65
+ message: 服务器内部错误,请稍后重试