This reference is generated from the package’s Pydantic models. Fields use their YAML aliases. Unknown fields are rejected. Cross-field rules implemented by validators may not appear in JSON Schema; run aqven check on a complete project.
| YAML field | Type | Required | Default | Constraints |
|---|
apiVersion | 'aqven/v1' | Yes | — | — |
kind | 'Type' | Yes | — | — |
type | 'record' | Yes | — | — |
description | string | Yes | — | minLength=1 |
pii | 'none' | 'pii' | 'sensitive' | No | 'none' | — |
fields | FieldDecl[] | Yes | — | minItems=1 |
JSON Schema
| YAML field | Type | Required | Default | Constraints |
|---|
apiVersion | 'aqven/v1' | Yes | — | — |
kind | 'Type' | Yes | — | — |
type | 'enum' | Yes | — | — |
description | string | Yes | — | minLength=1 |
pii | 'none' | 'pii' | 'sensitive' | No | 'none' | — |
values | EnumValue[] | Yes | — | minItems=1 |
JSON Schema
| YAML field | Type | Required | Default | Constraints |
|---|
apiVersion | 'aqven/v1' | Yes | — | — |
kind | 'Type' | Yes | — | — |
type | 'union' | Yes | — | — |
description | string | Yes | — | minLength=1 |
pii | 'none' | 'pii' | 'sensitive' | No | 'none' | — |
discriminator | string | Yes | — | — |
variants | UnionVariant[] | Yes | — | minItems=1 |
JSON Schema
| YAML field | Type | Required | Default | Constraints |
|---|
name | string | Yes | — | — |
description | string | Yes | — | minLength=1 |
fields | FieldDecl[] | No | [] | — |
JSON Schema
| YAML field | Type | Required | Default | Constraints |
|---|
apiVersion | 'aqven/v1' | Yes | — | — |
kind | 'Type' | Yes | — | — |
type | 'id' | Yes | — | — |
description | string | Yes | — | minLength=1 |
pii | 'none' | 'pii' | 'sensitive' | No | 'none' | — |
pattern | string | null | No | None | — |
maxLength | integer | null | No | None | — |
allowed_set | 'dynamic' | 'none' | No | 'none' | — |
code_format | 'prefixed_ordinal' | 'identity' | null | No | None | — |
JSON Schema
| YAML field | Type | Required | Default | Constraints |
|---|
apiVersion | 'aqven/v1' | Yes | — | — |
kind | 'Type' | Yes | — | — |
type | 'value' | Yes | — | — |
description | string | Yes | — | minLength=1 |
pii | 'none' | 'pii' | 'sensitive' | No | 'none' | — |
base | 'Text' | 'Int' | 'Float' | 'Bool' | 'Date' | 'DateTime' | Yes | — | — |
maxLength | integer | null | No | None | — |
maxItems | integer | null | No | None | — |
minimum | integer | number | null | No | None | — |
maximum | integer | number | null | No | None | — |
pattern | string | null | No | None | — |
enum | string[] | null | No | None | — |
JSON Schema
| YAML field | Type | Required | Default | Constraints |
|---|
value | string | Yes | — | — |
description | string | Yes | — | minLength=1 |
JSON Schema