amis/schemas/service.json

101 lines
3.4 KiB
JSON
Raw Normal View History

2020-05-27 14:57:40 +08:00
{
2020-08-21 15:28:22 +08:00
"$id": "https://houtai.baidu.com/v2/schemas/service.json#",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "https://houtai.baidu.com/v2/schemas/service.json#/definitions/common"
},
{
"additionalProperties": false,
"dependencies": {},
"patternProperties": {
"^(\\$ref|api|body|className|fetchOn|initFetch|initFetchOn|messages|name|schemaApi)$": {}
},
"properties": {
"$schema": {
"format": "uri",
"type": "string",
"description": "绑定 JSON 格式说明,可忽略!"
2020-05-27 14:57:40 +08:00
},
2020-08-21 15:28:22 +08:00
"type": {
"const": "service",
"description": "指定为 service 类型",
"type": "string"
2020-05-27 14:57:40 +08:00
}
2020-08-21 15:28:22 +08:00
},
"required": ["type"],
"type": "object"
}
],
"definitions": {
"common": {
"description": "amis Service 渲染器格式说明。https://baidu.github.io/amis/docs/renderers#service",
"properties": {
"$ref": {
"$ref": "https://houtai.baidu.com/v2/schemas/page.json#/definitions/$ref",
"description": "引用页面中的定义"
},
"api": {
"$ref": "https://houtai.baidu.com/v2/schemas/page.json#/definitions/api",
"description": "页面初始化的时候,可以设置一个 API 让其取拉取,发送数据会携带当前 data 数据(包含地址栏参数),获取得数据会合并到 data 中,供组件内使用。"
},
"body": {
"$ref": "https://houtai.baidu.com/v2/schemas/page.json#/definitions/container",
"description": "内容区域"
},
"className": {
"$ref": "https://houtai.baidu.com/v2/schemas/page.json#/definitions/className",
"description": "配置容器 className"
2020-05-27 14:57:40 +08:00
},
2020-08-21 15:28:22 +08:00
"fetchOn": {
"default": true,
"description": "是否要拉取?通过表达式来决定",
"type": "string"
},
"initFetch": {
"default": true,
"description": "是否默认就拉取?",
"type": "boolean"
},
"initFetchOn": {
"default": true,
"description": "是否默认就拉取?通过表达式来决定",
"type": "string"
},
"messages": {
"additionalProperties": false,
"properties": {
"fetchFailed": {
"description": "用来配置当 api 拉取失败时提示的信息",
"type": "string"
},
"fetchSuccess": {
"description": "用来配置当 api 拉取成功时提示的信息,当然不设置的话就不会提示。",
"type": "string"
2020-05-27 14:57:40 +08:00
}
2020-08-21 15:28:22 +08:00
},
"type": "object"
},
"name": {
"$ref": "https://houtai.baidu.com/v2/schemas/page.json#/definitions/name",
"description": "给当前组件设定一个名,方便其他组件引用。"
},
"schemaApi": {
"$ref": "https://houtai.baidu.com/v2/schemas/page.json#/definitions/api",
"description": "用来获取远程 Schema 的 api"
2020-05-27 14:57:40 +08:00
}
2020-08-21 15:28:22 +08:00
},
"type": "object"
2020-05-27 14:57:40 +08:00
},
2020-08-21 15:28:22 +08:00
"test": {
"properties": {
"type": {
"const": "service"
}
}
}
},
"description": "amis Service 渲染器格式说明。https://baidu.github.io/amis/docs/renderers#service",
"type": "object"
}