Avalara · API Governance Rules
Avalara API Rules
Spectral linting rules defining API design standards and conventions for Avalara.
21 Rules
error 10
warn 9
info 2
Rule Categories
get
info
no
openapi
operation
parameter
paths
request
response
schema
servers
Rules
warn
info-title-avalara-prefix
API title should reference Avalara or a named product
$.info.title
error
info-description-required
API info description must be present and non-empty
$.info
error
info-version-required
API version must be present
$.info
warn
info-contact-required
API contact information should be provided
$.info
error
openapi-version-3x
OpenAPI version must be 3.x
$
error
servers-required
At least one server must be defined
$
error
servers-https-only
All server URLs must use HTTPS
$.servers[*].url
warn
paths-no-trailing-slash
Paths should not have trailing slashes
$.paths[*]~
error
paths-no-query-strings
Paths should not contain query strings
$.paths[*]~
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
info
operation-summary-avalara-prefix
Operation summaries should start with Avalara
$.paths[*][get,post,put,patch,delete].summary
warn
operation-description-required
Every operation must have a description
$.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
operationId should use camelCase
$.paths[*][get,post,put,patch,delete].operationId
warn
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
All parameters must have a description
$.paths[*][get,post,put,patch,delete].parameters[*]
warn
request-body-json-content
Request bodies should include application/json content type
$.paths[*][post,put,patch].requestBody.content
error
response-description-required
All responses must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
info
schema-description-on-top-level
Top-level schemas should have a description
$.components.schemas[*]
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
no-empty-descriptions
Descriptions must not be empty strings
$..description