Bandwidth · API Governance Rules
Bandwidth API Rules
Spectral linting rules defining API design standards and conventions for Bandwidth.
16 Rules
error 9
warn 6
info 1
Rule Categories
get
info
openapi
operation
parameter
paths
response
schema
security
servers
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
servers-https-only
All server URLs must use HTTPS
$.servers[*].url
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-id-camel-case
OperationIds should use camelCase
$.paths[*][get,post,put,patch,delete].operationId
warn
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,patch,delete]
info
operation-summary-bandwidth-prefix
Operation summaries should start with "Bandwidth"
$.paths[*][get,post,put,patch,delete].summary
error
response-description-required
Every response must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
warn
response-401-defined
Operations should define 401 response
$.paths[*][post,put,patch,delete]
error
security-schemes-defined
Security schemes must be defined
$.components
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
warn
paths-kebab-case
Path segments should use kebab-case
$.paths