Amazon Simple Workflow Service · API Governance Rules
Amazon Simple Workflow Service API Rules
Spectral linting rules defining API design standards and conventions for Amazon Simple Workflow Service.
9 Rules
error 4
warn 5
Rule Categories
info
operation
parameter
response
security
Rules
error
info-title-required
Info title must be present.
$.info
warn
info-description-required
Info description must be present.
$.info
error
operation-summary-required
Every operation must have a summary.
$.paths[*][*]
warn
operation-summary-prefix
Operation summaries must start with 'Amazon SWF'.
$.paths[*][*].summary
error
operation-operationId-required
Every operation must have an operationId.
$.paths[*][*]
warn
operation-tags-required
Every operation must have at least one tag.
$.paths[*][*]
warn
parameter-description-required
Every parameter must have a description.
$.paths[*][*].parameters[*]
error
response-success-required
Every operation must have at least one 2xx response.
$.paths[*][*].responses
warn
security-schemes-defined
Security schemes must be defined.
$.components