Amazon Connect · API Governance Rules
Amazon Connect API Rules
Spectral linting rules defining API design standards and conventions for Amazon Connect.
36 Rules
error 16
warn 17
info 3
Rule Categories
delete
get
info
instance
no
openapi
operation
parameter
paths
request
response
schema
security
servers
tag
tags
Rules
warn
info-title-prefix
API title must start with "Amazon Connect"
$.info.title
error
info-description-required
Info object must have a description of at least 50 characters
$.info
error
info-version-required
Info object must have a version field
$.info
warn
info-contact-required
Info object should have a contact
$.info
error
openapi-version-3x
Must use OpenAPI 3.x
$
error
servers-defined
Servers array must be defined and non-empty
$
error
servers-https-only
All server URLs must use HTTPS
$.servers[*].url
warn
servers-description-required
Each server must have a description
$.servers[*]
warn
paths-kebab-case
Path segments must use kebab-case
$.paths[*]~
warn
paths-no-trailing-slash
Paths must not have trailing slashes
$.paths[*]~
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-amazon-connect-prefix
Operation summary must start with "Amazon Connect"
$.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-id-camel-case
OperationId must use camelCase
$.paths[*][get,post,put,patch,delete].operationId
error
operation-tags-required
All operations must have tags
$.paths[*][get,post,put,patch,delete]
warn
tags-defined
Tags array should be defined at the global level
$
warn
tag-description-required
Each global tag must have a description
$.tags[*]
error
parameter-description-required
All parameters must have a description
$.paths[*][*].parameters[*]
error
parameter-schema-required
All parameters must have a schema
$.paths[*][*].parameters[*]
info
parameter-name-snake-case
Query and header parameter names should use camelCase (AWS convention)
$.paths[*][*].parameters[?(@.in == 'query')].name
warn
request-body-description
Request body should have a description
$.paths[*][post,put,patch].requestBody
warn
request-body-json-content
Request body should support application/json
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
All operations must have at least one 2xx response
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
All responses must have a description
$.paths[*][*].responses[*]
warn
response-400-on-post
POST operations should return a 400 Bad Request response
$.paths[*].post.responses
warn
response-error-has-message
Error response schemas should include a message field
$.components.schemas.Error.properties
warn
schema-description-required
Top-level schemas should have a description
$.components.schemas[*]
warn
schema-properties-type-required
Schema properties should have a type defined
$.components.schemas[*].properties[*]
error
security-schemes-defined
Security schemes must be defined in components
$.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
info
operation-examples-encouraged
Operations should have examples in responses
$.paths[*][*].responses[*].content[*]
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
instance-id-path-param
Operations using InstanceId path parameter should document it consistently
$.paths[*][*].parameters[?(@.name == 'InstanceId')]