Ballerina · API Governance Rules
Ballerina API Rules
Spectral linting rules defining API design standards and conventions for Ballerina.
11 Rules
error 7
warn 3
info 1
Rule Categories
get
info
openapi
operation
parameter
paths
response
schema
Rules
error
info-title-required
Info must have a title
$.info
error
info-version-required
Info must have a version
$.info
error
openapi-version-3
Must use OpenAPI 3.x
$
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,patch,delete]
error
response-description-required
Every response must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
warn
parameter-description-required
All parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
warn
schema-type-defined
All schemas should have a type
$.components.schemas[*]
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
info
paths-kebab-case
Path segments should use kebab-case or snake_case
$.paths