Apache Flume · API Governance Rules
Apache Flume API Rules
Spectral linting rules defining API design standards and conventions for Apache Flume.
7 Rules
error 4
warn 2
info 1
Rule Categories
info
operation
response
schema
Rules
error
info-title-required
Info title must be defined
$.info
error
info-version-required
API version must be specified
$.info
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,delete,patch]
warn
operation-summary-apache-flume-prefix
Operation summaries should start with Apache Flume
$.paths[*][get,post,put,delete,patch].summary
error
operation-operationId-required
All operations must have an operationId
$.paths[*][get,post,put,delete,patch]
warn
response-description-required
All responses must have descriptions
$.paths[*][get,post,put,delete,patch].responses[*]
info
schema-description-recommended
Schemas should have descriptions
$.components.schemas[*]