Apache Hudi · API Governance Rules
Apache Hudi API Rules
Spectral linting rules defining API design standards and conventions for Apache Hudi.
13 Rules
error 2
warn 9
info 2
Rule Categories
hudi
no
operationid
path
schema
Rules
error
hudi-operation-summary
All Hudi Timeline Server API operations must have a summary
$.paths[*][get,put,post,delete,patch]
error
hudi-operation-id
All Hudi Timeline Server API operations must have an operationId
$.paths[*][get,put,post,delete,patch]
warn
hudi-operation-tags
All Hudi Timeline Server API operations must have at least one tag
$.paths[*][get,put,post,delete,patch]
warn
hudi-schema-description
All Hudi schema components must have a description
$.components.schemas[*]
info
hudi-property-description
All Hudi schema properties should have descriptions
$.components.schemas[*].properties[*]
warn
hudi-info-contact
API info must include contact information
$.info
warn
hudi-info-license
API info must include license information
$.info
warn
hudi-path-parameters-described
All Hudi path parameters must have descriptions
$.paths[*][*].parameters[?(@.in=='path')]
warn
path-params-casing
Path parameters should be camelCase (the dominant convention in this API).
$.paths[*].parameters[?(@.in=='path')].name
warn
operationid-casing
Operation IDs should be camelCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].operationId
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
info
schema-properties-casing
Schema properties should be camelCase (the dominant convention in this API).
$.components.schemas[*].properties
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description