Apache Dubbo · API Governance Rules
Apache Dubbo API Rules
Spectral linting rules defining API design standards and conventions for Apache Dubbo.
15 Rules
error 5
warn 9
info 1
Rule Categories
info
no
operation
parameter
paths
response
schema
Rules
error
info-title-required
Info title must be defined
$.info
warn
info-description-required
Info description must be present
$.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-dubbo-prefix
Operation summaries should start with Apache Dubbo
$.paths[*][get,post,put,delete,patch].summary
warn
operation-description-required
All operations must have a description
$.paths[*][get,post,put,delete,patch]
error
operation-operationId-required
All operations must have an operationId
$.paths[*][get,post,put,delete,patch]
warn
operation-tags-required
All operations must have at least one tag
$.paths[*][get,post,put,delete,patch]
warn
paths-kebab-case
Path segments should use kebab-case
$.paths
warn
paths-no-trailing-slash
Paths must not have trailing slashes
$.paths
warn
parameter-description-required
All parameters must have descriptions
$.paths[*][get,post,put,delete,patch].parameters[*]
error
response-success-required
Operations must define at least one 2xx response
$.paths[*][get,post,put,delete,patch].responses
warn
response-description-required
All responses must have descriptions
$.paths[*][get,post,put,delete,patch].responses[*]
info
schema-property-description
Schema properties should have descriptions
$.definitions[*].properties[*]
warn
no-empty-descriptions
Descriptions must not be empty strings
$..description