Amazon Lambda · API Governance Rules
Amazon Lambda API Rules
Spectral linting rules defining API design standards and conventions for Amazon Lambda.
16 Rules
error 9
warn 7
Rule Categories
info
openapi
operation
parameter
paths
schema
security
servers
Rules
warn
info-title-format
API title must start with "Amazon Lambda"
$.info.title
error
info-description-required
API must have a description
$.info
error
info-version-required
API must have a version
$.info
error
openapi-version
Must use OpenAPI 3.x
$
error
servers-required
Servers must be defined
$
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,delete,patch]
warn
operation-summary-prefix
Summaries must start with "Amazon Lambda"
$.paths[*][get,post,put,delete,patch].summary
error
operation-description-required
All operations must have a description
$.paths[*][get,post,put,delete,patch]
error
operation-operationid-required
All operations must have an operationId
$.paths[*][get,post,put,delete,patch]
warn
operation-tags-required
All operations must have tags
$.paths[*][get,post,put,delete,patch]
warn
parameter-description-required
All parameters must have descriptions
$.paths[*][*].parameters[*]
error
security-schemes-required
Security schemes must be defined
$.components
warn
security-global-required
Global security must be defined
$
warn
paths-kebab-case
Path segments should use kebab-case
$.paths
warn
schema-description-required
Schema components should have descriptions
$.components.schemas[*]