Apache Software Foundation · API Governance Rules
Apache Software Foundation API Rules
Spectral linting rules defining API design standards and conventions for Apache Software Foundation.
18 Rules
error 8
warn 7
info 3
Rule Categories
info
no
openapi
operation
paths
response
schema
servers
Rules
error
info-title-required
Info title is required
$.info
warn
info-description-required
Info description is required and should be at least 30 characters
$.info
error
info-version-required
API version is required
$.info
warn
info-license-required
License information is required for ASF projects
$.info
error
openapi-version-3
Use OpenAPI 3.x
$
error
servers-required
Servers array is required
$
warn
servers-https
All server URLs should use HTTPS
$.servers[*].url
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-description-required
All operations should have a description
$.paths[*][get,post,put,patch,delete,head,options]
error
operation-operationid-required
All operations must have an operationId
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-tags-required
All operations must have at least one tag
$.paths[*][get,post,put,patch,delete,head,options]
info
operation-summary-prefix
Operation summaries should start with "Apache Software Foundation"
$.paths[*][get,post,put,patch,delete,head,options].summary
error
response-success-required
Every operation should have at least one 2xx response
$.paths[*][get,post,put,patch,delete,head,options].responses
error
response-description-required
All responses must have a description
$.paths[*][get,post,put,patch,delete,head,options].responses[*]
warn
schema-type-required
All schema properties should have a type
$.components.schemas[*].properties[*]
info
schema-description-required
Top-level schemas should have descriptions
$.components.schemas[*]
info
paths-kebab-case
Path segments should use kebab-case
$.paths[*]~
warn
no-empty-descriptions
Descriptions should not be empty strings
$..description