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