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