AWS Step Functions · API Governance Rules
AWS Step Functions API Rules
Spectral linting rules defining API design standards and conventions for AWS Step Functions.
8 Rules
error 4
warn 3
info 1
Rule Categories
sfn
Rules
warn
sfn-operation-summary
All operations must have a summary starting with "AWS Step Functions"
$.paths[*][get,post,put,delete,patch]
error
sfn-operation-id
All operations must have an operationId
$.paths[*][get,post,put,delete,patch]
error
sfn-info-title
Info object must have a title
$.info
error
sfn-info-version
Info object must have a version
$.info
error
sfn-response-description
All responses must have a description
$.paths[*][*].responses[*]
info
sfn-microcks-annotation
Operations should have x-microcks-operation annotation
$.paths[*][get,post,put,delete,patch]
warn
sfn-schema-type
Schema components should have a type
$.components.schemas[*]
warn
sfn-security-defined
API security schemes should be defined
$