dtcs 0.3.0

Reference implementation of the Data Transformation Contract Standard (DTCS)
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

# Diagnostics Guide

Diagnostics are spec-level observations implemented in [`src/diagnostics/`](../../src/diagnostics/).

## Types

```rust
pub enum Severity {
    Information,
    Warning,
    Error,
}

pub enum DiagnosticStage {
    Parse,
    CanonicalObjectModel,
    Validation,
    Analysis,
    Planning,
    Compilation,
    Runtime,
}

pub enum DiagnosticCategory {
    Syntax,
    Structure,
    Type,
    Reference,
    Semantic,
    Compatibility,
    Capability,
    Runtime,
    Extension,
}

pub struct Diagnostic {
    pub id: String,
    pub severity: Severity,
    pub stage: DiagnosticStage,
    pub category: DiagnosticCategory,
    pub message: String,
    pub object_ref: Option<String>,
    pub remediation: Option<String>,
}
```

## Standard diagnostic identifiers

Defined in [`src/diagnostics/codes.rs`](../../src/diagnostics/codes.rs):

- `dtcs:parse-error`
- `dtcs:unsupported-version`
- `dtcs:missing-required-field`
- `dtcs:duplicate-identifier`
- `dtcs:invalid-identifier`
- `dtcs:unknown-field`
- `dtcs:missing-lineage`
- `dtcs:ambiguous-reference`
- `dtcs:invalid-type`
- `dtcs:unresolved-reference`
- `dtcs:invalid-semantic-action`
- `dtcs:invalid-rule`
- `dtcs:invalid-extension`
- `dtcs:invalid-metadata` (Phase 0.2)
- `dtcs:invalid-interface` (Phase 0.2)
- `dtcs:type-incompatible` (Phase 0.2)
- `dtcs:invalid-conversion` (Phase 0.2)
- `dtcs:incompatible-contract` (Phase 0.3)
- `dtcs:conditional-compatibility` (Phase 0.3)
- `dtcs:evolution-breaking-change` (Phase 0.3)
- `dtcs:deprecated-object` (Phase 0.3)
- `dtcs:invalid-version` (Phase 0.3)
- `dtcs:version-conflict` (Phase 0.3)

## Validation semantics

- `DiagnosticReport::is_valid()` returns `false` only when one or more **Error**-severity diagnostics are present.
- **Warning** and **Information** diagnostics do not block validation success.

Diagnostics must not alter transformation semantics.