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

# CLI Specification

Binary:

```bash
odcs
```

Commands:

```bash
odcs validate <path>
odcs validate <path> --dep <path> [--dep ...] [--include <dir>] [--registry <dir>]
odcs inspect <path>
odcs diagnostics <path>
odcs diff <old> <new>
odcs registry index <dir>
odcs registry lookup <dir> <id> [--version <ver>]
odcs registry list <dir>
odcs schema
odcs version
```

Output modes:

```bash
odcs validate contract.yaml
odcs validate contract.yaml --json
odcs validate contract.yaml --strict   # deprecated no-op since 0.4.0
odcs schema
odcs schema --json
odcs schema --url-only
```

Exit codes:

- `0` valid / no breaking diff changes
- `1` validation errors / breaking diff changes
- `2` parse or IO failure

## Cross-file validation (0.8.0+)

```bash
odcs validate consumer.yaml --dep provider.yaml --include ./contracts/
odcs validate consumer.yaml --registry ./contracts/
```

Requires `odcs registry index ./contracts/` before `--registry` validation.

## Local registry (0.9.0+)

```bash
odcs registry index ./contracts/
odcs registry lookup ./contracts/ provider-contract
odcs registry list ./contracts/
```

## Compatibility diff (0.8.0+)

```bash
odcs diff old.yaml new.yaml
odcs diff old.yaml new.yaml --json
```

Exit `0` when no breaking changes; `1` when breaking changes are detected.

## Validation (0.4.0+)

Default `validate` runs the Rust pipeline plus pinned ODCS v3.1.0 JSON Schema validation.

`--strict` is retained for backward compatibility but has no additional effect since 0.4.0.

`parse_strict()` (library API) parses and validates in one step, returning `Result<DataContract, DiagnosticReport>`. Unknown fields are rejected during serde deserialization at parse time — this is separate from the deprecated CLI `--strict` flag.

## `odcs schema`

| Flag | Output |
|------|--------|
| (default) | Full pinned JSON Schema to stdout |
| `--json` | `{"schemaVersion","upstreamUrl","schema"}` wrapper |
| `--url-only` | Upstream repository URL line only |

User-facing CLI documentation: [../user/cli.md](../user/cli.md).