odcs 0.9.1

Reference implementation of the Open Data Contract Standard (ODCS)
Documentation 
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

//! Schema object and property validation.

use crate::diagnostics::{
    codes, emit, validation_error, DiagnosticCategory, DiagnosticReport, ValidationPhase,
};
use crate::model::{DataContract, SchemaObject, SchemaProperty};

const SCHEMA_OBJECT_LOGICAL_TYPES: &[&str] = &["object"];

const PROPERTY_LOGICAL_TYPES: &[&str] = &[
    "string",
    "date",
    "timestamp",
    "time",
    "number",
    "integer",
    "object",
    "array",
    "boolean",
];

/// Validate schema objects and properties.
#[must_use]
pub fn validate(contract: &DataContract) -> DiagnosticReport {
    let mut report = DiagnosticReport::new();

    for (index, schema) in contract.schema.iter().enumerate() {
        let base_ref = format!("schema[{index}]");
        validate_schema_object(&mut report, schema, &base_ref);
    }

    report
}

fn validate_schema_object(report: &mut DiagnosticReport, schema: &SchemaObject, base_ref: &str) {
    if schema
        .element
        .name
        .as_ref()
        .map_or(true, |name| name.is_empty())
    {
        emit(
            report,
            validation_error(
                ValidationPhase::Schema,
                codes::INVALID_SCHEMA,
                DiagnosticCategory::Structure,
                "schema object name must not be empty",
            )
            .with_object_ref(format!("{base_ref}.name")),
        );
    }

    if let Some(logical_type) = schema.logical_type.as_deref() {
        if !SCHEMA_OBJECT_LOGICAL_TYPES.contains(&logical_type) {
            emit(
                report,
                validation_error(
                    ValidationPhase::Schema,
                    codes::INVALID_SCHEMA,
                    DiagnosticCategory::Structure,
                    format!(
                        "unsupported schema object logicalType '{logical_type}'; expected: {}",
                        SCHEMA_OBJECT_LOGICAL_TYPES.join(", ")
                    ),
                )
                .with_object_ref(format!("{base_ref}.logicalType")),
            );
        }
    }

    validate_properties(report, &schema.properties, base_ref);
}

fn validate_properties(report: &mut DiagnosticReport, properties: &[SchemaProperty], base: &str) {
    for (index, property) in properties.iter().enumerate() {
        let prop_ref = format!("{base}.properties[{index}]");
        if property
            .element
            .name
            .as_ref()
            .map_or(true, |name| name.is_empty())
        {
            emit(
                report,
                validation_error(
                    ValidationPhase::Schema,
                    codes::INVALID_SCHEMA,
                    DiagnosticCategory::Structure,
                    "schema property name must not be empty",
                )
                .with_object_ref(format!("{prop_ref}.name")),
            );
        }

        if let Some(logical_type) = property.logical_type.as_deref() {
            if !PROPERTY_LOGICAL_TYPES.contains(&logical_type) {
                emit(
                    report,
                    validation_error(
                ValidationPhase::Schema,
                        codes::INVALID_SCHEMA,
                        DiagnosticCategory::Structure,
                        format!(
                            "unsupported property logicalType '{logical_type}'; expected one of: {}",
                            PROPERTY_LOGICAL_TYPES.join(", ")
                        ),
                    )
                    .with_object_ref(format!("{prop_ref}.logicalType")),
                );
            }
        }

        if property.logical_type.as_deref() == Some("array") && property.items.is_none() {
            emit(
                report,
                validation_error(
                    ValidationPhase::Schema,
                    codes::INVALID_SCHEMA,
                    DiagnosticCategory::Structure,
                    "array properties require an items schema",
                )
                .with_object_ref(format!("{prop_ref}.items")),
            );
        }

        if property.logical_type.as_deref() == Some("object") && property.properties.is_empty() {
            emit(
                report,
                validation_error(
                    ValidationPhase::Schema,
                    codes::INVALID_SCHEMA,
                    DiagnosticCategory::Structure,
                    "object properties require at least one nested property",
                )
                .with_object_ref(format!("{prop_ref}.properties")),
            );
        }

        if !property.properties.is_empty() {
            validate_properties(report, &property.properties, &prop_ref);
        }

        if let Some(items) = &property.items {
            validate_properties(
                report,
                std::slice::from_ref(items),
                &format!("{prop_ref}.items"),
            );
        }
    }
}