Amazon WorkMail · API Governance Rules
Amazon WorkMail API Rules
Spectral linting rules defining API design standards and conventions for Amazon WorkMail.
19 Rules
error 8
warn 8
info 3
Rule Categories
components
get
info
no
openapi
operation
parameter
paths
request
response
schema
security
servers
Rules
warn
info-title-format
API title should reference Amazon WorkMail
$.info
error
info-description-required
API info must have a description
$.info
error
info-version-required
API info must have a version
$.info
error
openapi-version
Must use OpenAPI 3.0.x
$
error
servers-defined
At least one server must be defined
$
error
servers-https
All server URLs must use HTTPS
$.servers[*]
warn
paths-no-trailing-slash
Paths must not have a trailing slash
$.paths
error
operation-operationid-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
info
operation-summary-prefix
Operation summary should start with Amazon WorkMail
$.paths[*][get,post,put,patch,delete]
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 support application/json
$.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-recommended
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
warn
security-schemes-defined
Security schemes should be defined in components
$.components
info
components-schemas-exist
Components schemas should be defined for reuse
$.components