Apache Avro · API Governance Rules
Apache Avro API Rules
Spectral linting rules defining API design standards and conventions for Apache Avro.
15 Rules
error 9
warn 4
info 2
Rule Categories
avro
Rules
error
avro-schema-type-required
Avro schemas must specify a type.
$
error
avro-record-name-required
Avro record types must have a name.
$..[?(@.type == 'record')]
error
avro-record-fields-required
Avro record types must have a fields array.
$..[?(@.type == 'record')]
error
avro-field-name-required
Each Avro record field must have a name.
$..fields[*]
error
avro-field-type-required
Each Avro record field must have a type.
$..fields[*]
error
avro-enum-name-required
Avro enum types must have a name.
$..[?(@.type == 'enum')]
error
avro-enum-symbols-required
Avro enum types must define symbols.
$..[?(@.type == 'enum')]
error
avro-fixed-name-required
Avro fixed types must have a name.
$..[?(@.type == 'fixed')]
error
avro-fixed-size-required
Avro fixed types must specify a size.
$..[?(@.type == 'fixed')]
warn
avro-namespace-recommended
Avro named types should include a namespace.
$..[?(@.type == 'record' || @.type == 'enum' || @.type == 'fixed')]
warn
avro-doc-recommended
Avro schemas should include documentation.
$
info
avro-field-doc-recommended
Avro record fields should include documentation.
$..fields[*]
warn
avro-field-default-for-nullable
Nullable Avro fields should specify a default value.
$..fields[?(@.type[0] == 'null')]
info
avro-name-camel-case
Avro schema names should use camelCase or PascalCase.
$..name
warn
avro-namespace-dot-separated
Avro namespaces should use dot-separated package notation.
$..namespace