Amazon API Gateway · API Governance Rules
Amazon API Gateway API Rules
Spectral linting rules defining API design standards and conventions for Amazon API Gateway.
35 Rules
error 17
warn 17
info 1
Rule Categories
deprecation
info
method
no
openapi
operation
parameter
paths
request
response
schema
security
servers
tag
Rules
warn
info-title-prefix
API title must start with "Amazon API Gateway"
$.info.title
error
info-description-required
Info object must have a description with at least 20 characters
$.info
error
info-version-required
Info object must have a version
$.info
warn
info-contact-required
Info object should have contact information
$.info
error
openapi-version-3
All specs must use OpenAPI 3.x
$
error
servers-defined
Servers array must be defined and non-empty
$
error
servers-https
All server URLs must use HTTPS
$.servers[*].url
warn
servers-description
Each server should have a description
$.servers[*]
warn
paths-kebab-case
Path segments must use kebab-case (lowercase letters, numbers, hyphens)
$.paths[*]~
error
paths-no-trailing-slash
Paths must not have trailing slashes
$.paths[*]~
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-summary-prefix
Operation summaries must start with "Amazon API Gateway"
$.paths[*][get,post,put,patch,delete,head,options].summary
error
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete,head,options]
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-id-camel-case
OperationIds must use camelCase
$.paths[*][get,post,put,patch,delete,head,options].operationId
error
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete,head,options]
warn
tag-global-defined
All tags used in operations should be defined in the global tags array
$
warn
tag-description
Global tags should have descriptions
$.tags[*]
error
parameter-description-required
All parameters must have descriptions
$.paths[*][*].parameters[*]
error
parameter-schema-required
All parameters must have a schema with a type
$.paths[*][*].parameters[*]
warn
request-body-json-content
Request bodies should use application/json content type
$.paths[*][post,put,patch].requestBody.content
warn
request-body-description
Request bodies should have descriptions
$.paths[*][*].requestBody
error
response-success-required
Every operation must have at least one 2xx response
$.paths[*][get,post,put,patch,delete]
error
response-description-required
All responses must have descriptions
$.paths[*][*].responses[*]
warn
response-401-on-secured
Secured operations should document 401 Unauthorized response
$.paths[*][get,post,put,patch,delete]
warn
schema-description
Top-level component schemas should have descriptions
$.components.schemas[*]
warn
schema-type-required
Schema objects should define a type
$.components.schemas[*]
info
schema-property-snake-case
Schema property names should use snake_case
$.components.schemas[*].properties[*]~
error
security-schemes-defined
Security schemes must be defined in components
$
warn
security-sigv4-scheme
AWS SigV4 security scheme should be defined
$.components.securitySchemes
error
method-get-no-body
GET operations must not have a request body
$.paths[*].get
warn
method-delete-no-body
DELETE operations should not have a request body
$.paths[*].delete
warn
method-post-has-body
POST operations creating resources should have a request body
$.paths[*].post
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
warn
deprecation-documented
Deprecated operations should have a description explaining the deprecation
$.paths[*][*][?(@.deprecated == true)]