Validation

Intro

The KCL Validation tool supports basic configuration data verification capabilities. You can write a KCL schema to verify the type and value of the input JSON/YAML files.

How to use

There is a JSON format file data.json:

{
    "name": "Alice",
    "age": 18,
    "message": "This is Alice",
    "data": {
        "id": 1,
        "value": "value1"
    },
    "labels": {
        "key": "value"
    },
    "hc": [1, 2, 3]
}

Build a validated KCL file schema.k:

schema User:
    name: str
    age: int
    message?: str
    data: Data
    labels: {str:}
    hc: [int]
        
    check:
        age > 10

schema Data:
    id: int
    value: str

Execute the following command:

kcl-vet data.json schema.k

Specify the schema for validation

When multiple schema definitions exist in the KCL file, by default, the KCL Validation tool will use the first schema to check. If you need to specify a schema for verification, you can use the -d|--schema parameter

kcl-vet data.json schema.k -d User

Args

$ kcl-vet -h
USAGE:
    kcl-vet [OPTIONS] [ARGS]

ARGS:
    <data_file>    Validation data file
    <kcl_file>     KCL file

OPTIONS:
    -d, --schema <schema>
            Iterate through subdirectories recursively

        --format <format>
            Validation data file format, support YAML and JSON, default is JSON

    -h, --help
            Print help information

    -n, --attribute_name <attribute_name>
            The attribute name for the data loading