Skip to content

xsv_config/0.1.0/schema.json

src/cdm_data_loaders/schemas/xsv_config/0.1.0/schema.json
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://kbase.github.io/cdm-data-loaders/schemas/xsv_config/0.1.0/schema.json",
    "$vocabulary": {
        "https://json-schema.org/draft/2020-12/vocab/core": true,
        "https://json-schema.org/draft/2020-12/vocab/applicator": true,
        "https://json-schema.org/draft/2020-12/vocab/unevaluated": true,
        "https://json-schema.org/draft/2020-12/vocab/validation": true,
        "https://json-schema.org/draft/2020-12/vocab/meta-data": true,
        "https://json-schema.org/draft/2020-12/vocab/format-annotation": true,
        "https://json-schema.org/draft/2020-12/vocab/content": true
    },
    "title": "Draft 2020-12 meta-schema extended with x-xsv-config",
    "allOf": [
        {
            "$ref": "https://json-schema.org/draft/2020-12/schema"
        }
    ],
    "properties": {
        "x-xsv-config": {
            "type": "object",
            "properties": {
                "x-has-header": {
                    "type": "boolean",
                    "description": "whether or not the file has a header line"
                },
                "x-delimiter": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 1,
                    "description": "the delimiter used to demarcate columns in the xsv file"
                },
                "x-comment-char": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 1,
                    "description": "the comment character"
                },
                "x-quote": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 1,
                    "description": "quote character"
                },
                "x-escape": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 1,
                    "description": "escape character"
                },
                "x-quoting-policy": {
                    "type": "string",
                    "enum": [
                        "all",
                        "necessary",
                        "nonnumeric",
                        "never"
                    ],
                    "description": "Quoting style to use when writing XSV using qsv. Possible values: all, necessary, nonnumeric and never.\n\nAll: Quotes all fields. \nNecessary: Quotes fields only when necessary - when fields contain a quote, delimiter or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field).\nNonNumeric: Quotes all fields that are non-numeric.\nNever: Never write quotes, even if the resulting XSV file is invalid."
                },
                "x-null-regex": {
                    "type": "string",
                    "description": "regular expression capturing the strings that are used to represent NULL values"
                },
                "x-null-cols": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "minItems": 1,
                    "description": "list of columns in which the null regex is applicable; if not supplied, it is assumed that all columns may contain the NULL value"
                }
            },
            "additionalProperties": false,
            "anyOf": [
                {
                    "required": [
                        "x-has-header"
                    ]
                },
                {
                    "required": [
                        "x-delimiter"
                    ]
                },
                {
                    "required": [
                        "x-comment-char"
                    ]
                },
                {
                    "required": [
                        "x-quote"
                    ]
                },
                {
                    "required": [
                        "x-escape"
                    ]
                },
                {
                    "required": [
                        "x-quoting-policy"
                    ]
                },
                {
                    "required": [
                        "x-null-regex"
                    ]
                },
                {
                    "required": [
                        "x-null-cols"
                    ]
                }
            ]
        }
    }
}