Apache Hudi · API Governance Rules
Apache Hudi API Rules
Spectral linting rules defining API design standards and conventions for Apache Hudi.
8 Rules
error 2
warn 5
info 1
Rule Categories
hudi
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')]