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

# Validation Guide

Validation is deterministic and phase-based. The `validate()` function in [`src/validation/mod.rs`](../../src/validation/mod.rs) orchestrates these phases:

| Phase | Module | Checks |
|-------|--------|--------|
| Document | `document.rs` | Required root fields, `apiVersion` support |
| Structural | `structural.rs` | Reserved for future cross-field rules |
| Schema | `schema.rs` | Schema names, `logicalType` enums, array/object shape |
| Quality | `quality.rs` | Rule types, metrics, dimensions, operators |
| References | `references.rs` | Relationship endpoints and types |
| Extensions | `extensions.rs` | Custom property keys, authoritative definitions |
| Servers | `servers.rs` | Server name, `type` enum, type-specific required fields |
| Sections | `sections.rs` | Team, roles, support, SLA sections |
| IDs | `ids.rs` | StableId patterns |
| JSON Schema | `json_schema.rs` | Pinned ODCS v3.1.0 schema (always runs in 0.4.0+) |

`ValidationPhase` in [`src/diagnostics/validation_phase.rs`](../../src/diagnostics/validation_phase.rs) identifies the validator that produced each validation diagnostic. Since 0.6.0, every validation-stage diagnostic includes `validationPhase` in JSON and CLI output.

## Return type

`validate()` returns a `DiagnosticReport` (also available as `ValidationReport`). Use `report.is_valid()` to check for errors.

```rust
use odcs::{parse, validate, DocumentFormat};

let result = parse(content, DocumentFormat::Yaml);
let contract = result.contract.expect("parse succeeded");
let report = validate(&contract);
assert!(report.is_valid());
```

## Version fields

- `version` — contract document revision (any non-empty string, e.g. `1.0.0`)
- `apiVersion` — ODCS spec release; this implementation requires `v3.1.0`

## Validation options (deprecated)

`ValidationOptions` and `--strict` are retained for backward compatibility. Since 0.4.0, JSON Schema validation always runs; `strict` has no effect.

```rust
use odcs::{validate_strict, ValidationOptions};

// Aliases for validate() since 0.4.0
let _ = validate_strict(&contract);
let _ = validate_with_options(&contract, ValidationOptions::strict());
```

## Intentional extensions

See [SPEC.md](../../SPEC.md) spec parity policy for rules stricter than JSON Schema (relationship resolution, composite parity).

## User-facing reference

For diagnostic codes and CLI integration, see [../user/diagnostics.md](../user/diagnostics.md).