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