Apache ShardingSphere · API Governance Rules
Apache ShardingSphere API Rules
Spectral linting rules defining API design standards and conventions for Apache ShardingSphere.
6 Rules
error 4
warn 2
Rule Categories
apache
Rules
error
apache-shardingsphere-info-title-required
Info object must have a title
$.info
error
apache-shardingsphere-operation-summary-required
All operations must have a summary
$.paths[*][*]
error
apache-shardingsphere-operation-operationId-required
All operations must have an operationId
$.paths[*][*]
warn
apache-shardingsphere-operation-tags-required
All operations must have tags
$.paths[*][*]
warn
apache-shardingsphere-operation-summary-apache-prefix
Operation summaries should be prefixed with Apache ShardingSphere
$.paths[*][*].summary
error
apache-shardingsphere-response-success-required
All operations must have a success response
$.paths[*][*].responses