odcs 0.3.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

//! ODCS validation pipeline.

mod document;
mod extensions;
mod phases;
mod quality;
mod references;
mod schema;
mod structural;

pub use phases::ValidationPhase;

use crate::diagnostics::{
    codes, com_error, emit, validation_error, DiagnosticCategory, DiagnosticReport,
};
use crate::model::DataContract;

/// Validate a parsed data contract.
#[must_use]
pub fn validate(contract: &DataContract) -> DiagnosticReport {
    let mut report = DiagnosticReport::new();

    if !contract.is_supported_version() {
        emit(
            &mut report,
            com_error(
                codes::UNSUPPORTED_VERSION,
                DiagnosticCategory::Compatibility,
                format!(
                    "unsupported ODCS version '{}'; supported: {:?}",
                    contract.version,
                    crate::model::SUPPORTED_ODCS_VERSIONS
                ),
            )
            .with_object_ref("version")
            .with_remediation("set version to a supported ODCS release"),
        );
    }

    if !contract.is_supported_api_version() {
        emit(
            &mut report,
            com_error(
                codes::UNSUPPORTED_VERSION,
                DiagnosticCategory::Compatibility,
                format!(
                    "unsupported ODCS apiVersion '{}'; supported: {:?}",
                    contract.api_version,
                    crate::model::SUPPORTED_API_VERSIONS
                ),
            )
            .with_object_ref("apiVersion")
            .with_remediation("set apiVersion to a supported ODCS release"),
        );
    }

    if contract.id.is_empty() {
        emit(
            &mut report,
            validation_error(
                codes::MISSING_REQUIRED_FIELD,
                DiagnosticCategory::Structure,
                "contract id must not be empty",
            )
            .with_object_ref("id"),
        );
    }

    if contract.api_version.is_empty() {
        emit(
            &mut report,
            validation_error(
                codes::MISSING_REQUIRED_FIELD,
                DiagnosticCategory::Structure,
                "contract apiVersion must not be empty",
            )
            .with_object_ref("apiVersion"),
        );
    }

    if contract.kind != "DataContract" {
        emit(
            &mut report,
            validation_error(
                codes::INVALID_SCHEMA,
                DiagnosticCategory::Structure,
                format!("expected kind 'DataContract', got '{}'", contract.kind),
            )
            .with_object_ref("kind"),
        );
    }

    report
}