odcs 0.8.0

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

//! ODCS validation pipeline.

mod dedup;
mod document;
mod extensions;
mod helpers;
mod ids;
mod json_schema;
mod phases;
mod quality;
mod references;
mod schema;
mod schema_index;
mod sections;
mod servers;
mod structural;

pub use phases::ValidationPhase;
pub use schema_index::{ContractIndex, SchemaIndex};

use crate::diagnostics::DiagnosticReport;
use crate::model::DataContract;
use crate::validation::schema_index::ContractIndex as ContractIndexType;

/// Options controlling validation behavior.
///
/// As of 0.4.0, JSON Schema validation always runs. The `strict` flag is
/// retained for backward compatibility and has no effect.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub struct ValidationOptions {
    /// Deprecated: JSON Schema validation is always enabled in 0.4.0+.
    pub strict: bool,
}

impl ValidationOptions {
    /// Default validation options.
    #[must_use]
    pub const fn default_options() -> Self {
        Self { strict: false }
    }

    /// Deprecated alias for default options (strict mode is always on in 0.4.0+).
    #[must_use]
    pub const fn strict() -> Self {
        Self { strict: true }
    }
}

fn run_validation_pipeline(
    contract: &DataContract,
    contract_index: Option<&ContractIndexType>,
) -> DiagnosticReport {
    let mut report = DiagnosticReport::new();
    report.merge(document::validate(contract));
    report.merge(structural::validate(contract));
    report.merge(schema::validate(contract));
    report.merge(quality::validate(contract));
    if contract_index.is_some() {
        report.merge(references::validate_with_index(contract, contract_index));
    } else {
        report.merge(references::validate(contract));
    }
    report.merge(extensions::validate(contract));
    report.merge(servers::validate(contract));
    report.merge(sections::validate(contract));
    report.merge(ids::validate(contract));
    report.merge(json_schema::validate(contract));
    dedup::dedup_json_schema_overlap(&mut report);
    report
}

/// Validate a parsed data contract (Rust pipeline + JSON Schema).
#[must_use]
pub fn validate(contract: &DataContract) -> DiagnosticReport {
    validate_with_options(contract, ValidationOptions::default_options())
}

/// Validate a parsed data contract.
#[must_use]
pub fn validate_with_options(
    contract: &DataContract,
    _options: ValidationOptions,
) -> DiagnosticReport {
    run_validation_pipeline(contract, None)
}

/// Validate a parsed data contract with optional cross-file reference index.
#[must_use]
pub fn validate_with_contract_index(
    contract: &DataContract,
    _options: ValidationOptions,
    contract_index: Option<&ContractIndexType>,
) -> DiagnosticReport {
    run_validation_pipeline(contract, contract_index)
}

/// Validate a parsed data contract (alias for [`validate`] since 0.4.0).
#[must_use]
pub fn validate_strict(contract: &DataContract) -> DiagnosticReport {
    validate(contract)
}