WhatsApp · API Governance Rules
WhatsApp API Rules
Spectral linting rules defining API design standards and conventions for WhatsApp.
17 Rules
error 14
warn 2
info 1
Rule Categories
get
info
no
operation
parameter
paths
response
security
servers
tags
Rules
error
info-title-required
API title must be present.
$.info
warn
info-title-format
Title should start with "WhatsApp".
$.info.title
error
info-description-required
API description must be present.
$.info
error
info-version-required
API version must be specified.
$.info
error
servers-defined
At least one server must be defined.
$
error
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
error
paths-no-trailing-slash
Paths must not have trailing slashes.
$.paths
error
operation-description-required
Every operation must have a description.
$.paths[*][get,post,put,patch,delete]
error
operation-operationid-required
Every operation must have an operationId.
$.paths[*][get,post,put,patch,delete]
error
operation-operationid-unique
Operation IDs must be unique.
$
info
tags-title-case
Tag names should use Title Case.
$.tags[*].name
error
parameter-description-required
All parameters must have a description.
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
Every operation must define a success response.
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
All responses must have a description.
$.paths[*][get,post,put,patch,delete].responses[*]
warn
security-schemes-defined
Security schemes should be defined.
$.components
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
error
no-empty-descriptions
Descriptions must not be empty.
$..description