Amazon Pinpoint · API Governance Rules
Amazon Pinpoint API Rules
Spectral linting rules defining API design standards and conventions for Amazon Pinpoint.
35 Rules
error 14
warn 16
info 5
Rule Categories
delete
get
info
no
openapi
operation
parameter
paths
request
response
schema
security
servers
tags
Rules
warn
info-title-contains-amazon-pinpoint
API title must reference Amazon Pinpoint
$.info.title
error
info-description-required
API must have a description
$.info
error
info-version-required
API version must be defined
$.info
warn
info-contact-required
API must provide contact information
$.info
error
openapi-version-3
API should use OpenAPI 3.x
$.openapi
error
servers-defined
Servers must be defined
$
warn
servers-https
All server URLs must use HTTPS
$.servers[*].url
warn
paths-kebab-case
Path segments must use kebab-case
$.paths
warn
paths-no-trailing-slash
Paths must not have trailing slashes
$.paths
info
paths-v1-prefix
All paths must start with /v1/
$.paths
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,patch,delete,options,head]
warn
operation-summary-amazon-pinpoint-prefix
Summaries must begin with 'Amazon Pinpoint'
$.paths[*][get,post,put,patch,delete].summary
error
operation-description-required
All operations must have a description
$.paths[*][get,post,put,patch,delete,options,head]
error
operation-id-required
All operations must have an operationId
$.paths[*][get,post,put,patch,delete,options,head]
warn
operation-id-pascal-case
OperationId must use PascalCase
$.paths[*][get,post,put,patch,delete].operationId
error
operation-tags-required
All operations must have tags
$.paths[*][get,post,put,patch,delete,options,head]
warn
tags-global-defined
Global tags must be defined
$
warn
tags-title-case
Tag names must use Title Case
$.tags[*].name
warn
tags-description-required
Tags must have descriptions
$.tags[*]
error
parameter-description-required
All parameters must have descriptions
$.paths[*][*].parameters[*]
error
parameter-schema-required
All parameters must have a schema
$.paths[*][*].parameters[*]
warn
request-body-description
Request bodies should have descriptions
$.paths[*][post,put,patch].requestBody
warn
request-body-json-content
Request bodies should support application/json
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
All operations must have a success response
$.paths[*][get,post,put,patch,delete]
error
response-description-required
All responses must have descriptions
$.paths[*][*].responses[*]
info
response-401-defined
Operations should define 401 unauthorized responses
$.paths[*][get,post,put,patch,delete].responses
info
response-404-defined
Operations should define 404 not found responses
$.paths[*][get,put,patch,delete].responses
info
schema-property-description
Schema properties should have descriptions
$.components.schemas[*].properties[*]
warn
schema-type-defined
Schemas must define a type
$.components.schemas[*]
error
security-schemes-defined
Security schemes must be defined
$.components
warn
security-global-defined
Global security must be defined
$
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body
$.paths[*].delete
warn
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
operation-examples-encouraged
Operations should provide examples for responses
$.paths[*][*].responses[*].content[*]