Amazon SES · API Governance Rules
Amazon SES API Rules
Spectral linting rules defining API design standards and conventions for Amazon SES.
19 Rules
error 8
warn 10
info 1
Rule Categories
delete
get
info
openapi
operation
parameter
response
schema
security
server
servers
Rules
error
info-title-required
API must have a title
$.info
warn
info-description-required
API must have a description
$.info
error
info-version-required
API must have a version
$.info
error
openapi-version-3
API must use OpenAPI 3.x
$
error
servers-defined
Servers must be defined
$
warn
server-https
Server URLs should use HTTPS
$.servers[*]
error
operation-summary-required
Operations must have a summary
$.paths[*][get,post,put,patch,delete,options,head]
warn
operation-description-required
Operations must have a description
$.paths[*][get,post,put,patch,delete,options,head]
error
operation-id-required
Operations must have an operationId
$.paths[*][get,post,put,patch,delete,options,head]
warn
operation-id-camel-case
OperationId should use camelCase
$.paths[*][get,post,put,patch,delete,options,head]
warn
operation-tags-required
Operations must have tags
$.paths[*][get,post,put,patch,delete,options,head]
warn
parameter-description-required
Parameters must have descriptions
$.paths[*][*].parameters[*]
error
response-success-required
Operations must have a success response
$.paths[*][get,post,put,patch,delete]
warn
response-description-required
Responses must have descriptions
$.paths[*][*].responses[*]
warn
schema-type-defined
Schema properties should have types
$.components.schemas[*].properties[*]
info
schema-description-required
Top-level schemas should have descriptions
$.components.schemas[*]
warn
security-schemes-defined
Security schemes should be defined
$.components
error
get-no-request-body
GET operations should not have a request body
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body
$.paths[*].delete