yao-app-ts-types/json-schemas/0.10.4/importer.json

typescript types for yao application

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$ref": "#/definitions/YaoImport.Importer",
  "definitions": {
    "YaoImport.Importer": {
      "type": "object",
      "properties": {
        "version": {
          "type": "string",
          "description": "版本【管理字段】"
        },
        "decription": {
          "type": "string",
          "description": "描述【管理字段】"
        },
        "comment": {
          "type": "string",
          "description": "备注【管理字段】"
        },
        "title": {
          "type": "string",
          "description": "导入名称"
        },
        "process": {
          "type": "string",
          "description": "处理器名称"
        },
        "output": {
          "type": "string",
          "description": "The process import output"
        },
        "columns": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/YaoImport.Column"
          },
          "description": "字段列表"
        },
        "option": {
          "$ref": "#/definitions/YaoImport.Option",
          "description": "导入配置项"
        },
        "rules": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "许可导入规则"
        },
        "$schema": {
          "type": "string"
        }
      },
      "required": [
        "process",
        "columns"
      ],
      "additionalProperties": false,
      "description": "数据导入器"
    },
    "YaoImport.Column": {
      "type": "object",
      "properties": {
        "label": {
          "type": "string",
          "description": "字段标签"
        },
        "name": {
          "type": "string",
          "description": "字段名称"
        },
        "field": {
          "type": "string",
          "description": "字段名称(原始值),不需要配置"
        },
        "match": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "匹配建议"
        },
        "rules": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "清洗规则定义"
        },
        "nullable": {
          "type": "boolean",
          "description": "是否可以为空"
        },
        "primary": {
          "type": "boolean",
          "description": "是否为主键"
        }
      },
      "required": [
        "label",
        "name"
      ],
      "additionalProperties": false,
      "description": "导入字段定义"
    },
    "YaoImport.Option": {
      "type": "object",
      "properties": {
        "useTemplate": {
          "type": "boolean",
          "description": "使用已匹配过的模板"
        },
        "templateLink": {
          "type": "string",
          "description": "默认数据模板链接"
        },
        "chunkSize": {
          "type": "number",
          "description": "每次处理记录数量"
        },
        "mappingPreview": {
          "type": "string",
          "description": "显示字段映射界面方式 auto 匹配模板失败显示, always 一直显示, never 不显示"
        },
        "dataPreview": {
          "type": "string",
          "description": "数据预览界面方式 auto 有异常数据时显示, always 一直显示, never 不显示"
        }
      },
      "additionalProperties": false,
      "description": "导入配置项定"
    }
  }
}