Skip to content

Commit b2b1cd9

Browse files
committed
APX-116: Update validation docs to reflect native Go validators for Avro, JSON Schema, Parquet
Replace stale avro-tools/json-schema-diff references in validation-commands.md and publishing/validation.md with accurate tool names (Native Go / jsonschema-diff).
1 parent 7e4d18a commit b2b1cd9

2 files changed

Lines changed: 12 additions & 12 deletions

File tree

docs/cli-reference/validation-commands.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ If `path` is omitted, APX detects schema directories from `module_roots` in `apx
2424
|--------|------|----------------|
2525
| Protocol Buffers | `buf lint` | Naming conventions, package structure, field numbering, service definitions |
2626
| OpenAPI | Spectral | Schema structure, endpoint definitions, response formats |
27-
| Avro | avro-tools | Record structure, field defaults, type compatibility |
28-
| JSON Schema | json-schema-diff | Schema validity, reference resolution |
29-
| Parquet | built-in | Column definitions, type constraints |
27+
| Avro | Native Go | Record structure, field type validity, required `name`/`fields` presence |
28+
| JSON Schema | Native Go | JSON syntax, `$schema` URI, `type`, `properties`, `required` |
29+
| Parquet | Native Go | Message-notation syntax, physical type validity, repetition levels |
3030

3131
For protobuf, APX also runs `go_package` validation — warning if the `go_package` option doesn't match the canonical import path.
3232

@@ -87,9 +87,9 @@ apx breaking --against abc1234
8787
|--------|------|---------------------------|
8888
| Protocol Buffers | `buf breaking` | Field removal/renumbering, type changes, service/method removal |
8989
| OpenAPI | `oasdiff breaking` | Endpoint removal, required field additions, response type changes |
90-
| Avro | avro-tools | Field removal, type narrowing, default changes |
91-
| JSON Schema | json-schema-diff | Property removal, type restriction, required additions |
92-
| Parquet | built-in | Column removal, type changes |
90+
| Avro | Native Go | New fields without defaults, type changes (BACKWARD/FORWARD/FULL/NONE modes) |
91+
| JSON Schema | `jsonschema-diff` | Property removal, type restriction, required additions |
92+
| Parquet | Native Go | New required columns, removed columns, type/annotation changes, optional→required promotion |
9393

9494
### Examples
9595

docs/publishing/validation.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ Runs format-specific linting on all schema files:
2525
|--------|------|--------|
2626
| Protocol Buffers | `buf lint` | Naming conventions, package structure, field numbering |
2727
| OpenAPI | Spectral | Endpoint definitions, response formats, schema structure |
28-
| Avro | avro-tools | Record structure, field defaults |
29-
| JSON Schema | json-schema-diff | Schema validity, reference resolution |
30-
| Parquet | built-in | Column definitions, type constraints |
28+
| Avro | Native Go | Record structure, type validity, required fields |
29+
| JSON Schema | Native Go | JSON syntax, `$schema` URI, `type`, `properties`, `required` |
30+
| Parquet | Native Go | Message-notation syntax, physical type validity, repetition levels |
3131

3232
### Breaking Changes
3333

@@ -37,9 +37,9 @@ Detects backward-incompatible changes:
3737
|--------|------|---------|
3838
| Protocol Buffers | `buf breaking` | Field removal/renumbering, type changes, service removal |
3939
| OpenAPI | `oasdiff breaking` | Endpoint removal, required field additions |
40-
| Avro | avro-tools | Field removal, type narrowing |
41-
| JSON Schema | json-schema-diff | Property removal, type restrictions |
42-
| Parquet | built-in | Column removal, type changes |
40+
| Avro | Native Go | New fields without defaults, type changes (configurable compatibility mode) |
41+
| JSON Schema | `jsonschema-diff` | Property removal, type restrictions, required additions |
42+
| Parquet | Native Go | New required columns, removed columns, type/annotation changes |
4343

4444
---
4545

0 commit comments

Comments
 (0)