Amazon Step Functions · API Governance Rules
Amazon Step Functions API Rules
Spectral linting rules defining API design standards and conventions for Amazon Step Functions.
19 Rules
error 11
warn 7
info 1
Rule Categories
get
info
no
openapi
operation
parameter
response
schema
security
servers
tags
Rules
warn
info-title-prefix
API title must start with "Amazon" or "AWS"
$.info.title
error
info-description-required
Info object must have a description
$.info
error
info-version-required
Info object must have a version
$.info
error
openapi-version
Must use OpenAPI 3.x
$
error
servers-required
Servers must be defined
$
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,delete,patch]
warn
operation-summary-amazon-prefix
Operation summary must start with "Amazon" or "AWS"
$.paths[*][get,post,put,delete,patch].summary
warn
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,delete,patch]
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,delete,patch]
warn
operation-id-pascal-case
OperationId must use PascalCase
$.paths[*][get,post,put,delete,patch].operationId
warn
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,delete,patch]
warn
parameter-description-required
Every parameter must have a description
$.paths[*][get,post,put,delete,patch].parameters[*]
error
response-success-required
Every operation must have a 2xx or 200 response
$.paths[*][get,post,put,delete,patch].responses
error
response-description-required
Every response must have a description
$.paths[*][get,post,put,delete,patch].responses[*]
info
schema-description-on-objects
Object schemas should have descriptions
$.components.schemas[?(@.type == 'object')]
error
security-schemes-defined
Security schemes must be defined in components
$
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
warn
tags-title-case
Tags should use Title Case
$.tags[*].name