Apache ZooKeeper · API Governance Rules
Apache ZooKeeper API Rules
Spectral linting rules defining API design standards and conventions for Apache ZooKeeper.
10 Rules
error 7
warn 1
info 2
Rule Categories
info
operation
paths
response
servers
Rules
error
info-title-required
Info title is required
$.info
error
info-version-required
API version is required
$.info
error
servers-required
Servers array must be defined
$
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,patch,delete]
error
operation-operationid-required
All operations must have an operationId
$.paths[*][get,post,put,patch,delete]
info
operation-summary-prefix
Operation summaries should start with "Apache ZooKeeper"
$.paths[*][get,post,put,patch,delete].summary
error
response-success-required
Every operation should have at least one 2xx response
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
All responses must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
warn
operation-tags-required
All operations should have at least one tag
$.paths[*][get,post,put,patch,delete]
info
paths-kebab-case
Path segments should use kebab-case or be simple command names
$.paths[*]~