Apache Helix · API Governance Rules
Apache Helix API Rules
Spectral linting rules defining API design standards and conventions for Apache Helix.
8 Rules
error 2
warn 5
info 1
Rule Categories
helix
Rules
error
helix-operation-summary
All Helix REST API operations must have a summary
$.paths[*][get,put,post,delete,patch]
error
helix-operation-id
All Helix REST API operations must have an operationId
$.paths[*][get,put,post,delete,patch]
warn
helix-operation-tags
All Helix REST API operations must have at least one tag
$.paths[*][get,put,post,delete,patch]
warn
helix-schema-description
All Helix schema components must have a description
$.components.schemas[*]
info
helix-property-description
All Helix schema properties should have descriptions
$.components.schemas[*].properties[*]
warn
helix-info-contact
API info must include contact information
$.info
warn
helix-info-license
API info must include license information
$.info
warn
helix-path-parameters-described
All Helix path parameters must have descriptions
$.paths[*][*].parameters[?(@.in=='path')]