Apache BookKeeper · API Governance Rules
Apache BookKeeper API Rules
Spectral linting rules defining API design standards and conventions for Apache BookKeeper.
12 Rules
error 3
warn 8
info 1
Rule Categories
bookkeeper
Rules
error
bookkeeper-admin-info-title
API info must have a title
$.info
warn
bookkeeper-admin-info-description
API info must have a description
$.info
error
bookkeeper-admin-info-version
API info must have a version
$.info
error
bookkeeper-admin-operation-id
All operations must have an operationId
$.paths[*][get,put,post,delete,patch]
warn
bookkeeper-admin-operation-summary
All operations must have a summary
$.paths[*][get,put,post,delete,patch]
warn
bookkeeper-admin-operation-tags
All operations must have at least one tag
$.paths[*][get,put,post,delete,patch]
warn
bookkeeper-admin-response-200
GET and PUT operations should have a 200 response
$.paths[*][get,put]
warn
bookkeeper-admin-schema-title
All component schemas must have a title
$.components.schemas[*]
warn
bookkeeper-admin-schema-description
All component schemas must have a description
$.components.schemas[*]
warn
bookkeeper-admin-summary-prefix
Operation summaries should start with Apache BookKeeper
$.paths[*][get,put,post,delete,patch].summary
warn
bookkeeper-admin-path-lowercase
API paths should use lowercase letters
$.paths
info
bookkeeper-admin-microcks-operation
All operations should have x-microcks-operation extension
$.paths[*][get,put,post,delete,patch]