Amazon Polly · API Governance Rules
Amazon Polly API Rules
Spectral linting rules defining API design standards and conventions for Amazon Polly.
22 Rules
error 12
warn 7
info 3
Rule Categories
get
info
no
openapi
operation
parameter
paths
response
schema
security
servers
Rules
warn
info-title-contains-amazon-polly
API title must reference Amazon Polly
$.info.title
error
info-description-required
API must have a description
$.info
error
info-version-required
API version must be defined
$.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
info
paths-kebab-case
Path segments must use kebab-case or camelCase
$.paths
info
paths-v1-prefix
All paths should start with /v1/
$.paths
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-amazon-polly-prefix
Summaries must begin with 'Amazon Polly'
$.paths[*][get,post,put,patch,delete].summary
error
operation-description-required
All operations must have a description
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
All operations must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
All operations must have tags
$.paths[*][get,post,put,patch,delete]
error
parameter-description-required
All parameters must have descriptions
$.paths[*][*].parameters[*]
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[*]
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
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
operation-examples-encouraged
Operations should provide examples
$.paths[*][*].responses[*].content[*]