Apache Ozone · API Governance Rules
Apache Ozone API Rules
Spectral linting rules defining API design standards and conventions for Apache Ozone.
6 Rules
error 3
warn 1
info 2
Rule Categories
info
operation
paths
security
Rules
error
info-title-required
API must have a title
$.info
error
operation-summary-required
$.paths[*][*]
error
operation-operationId-required
$.paths[*][*]
info
operation-summary-apache-prefix
Summaries should start with Apache Ozone
$.paths[*][get,post,put,delete,patch,head].summary
info
paths-s3-compatible
Paths should follow S3 bucket/key pattern
$.paths[*]~
warn
security-s3-auth
S3 API should use AWS Signature authentication
$.info