Amazon Aurora DSQL · API Governance Rules
Amazon Aurora DSQL API Rules
Spectral linting rules defining API design standards and conventions for Amazon Aurora DSQL.
10 Rules
error 5
warn 5
Rule Categories
aurora
Rules
warn
aurora-dsql-operation-id-camel-case
All operationIds must be camelCase
$.paths[*][*].operationId
warn
aurora-dsql-summary-prefix
All operation summaries must start with Amazon Aurora DSQL
$.paths[*][*].summary
warn
aurora-dsql-has-tags
All operations must have tags
$.paths[*][*]
error
aurora-dsql-response-200
All operations must have a 200 response
$.paths[*][*].responses
error
aurora-dsql-cluster-status-enum
ClusterStatus must use valid enum values
$.components.schemas.ClusterStatus
error
aurora-dsql-security-sigv4
API must use sigv4 security scheme
$.security[*]
warn
aurora-dsql-server-url-fixed
Server URL must be fixed without variables
$.servers[*]
warn
aurora-dsql-example-microcks-default
All examples must have x-microcks-default set to true
$.paths[*][*].responses[*].content[*].examples.default
error
aurora-dsql-multi-region-linked-list-required
CreateMultiRegionClustersInput must require linkedRegionList
$.components.schemas.CreateMultiRegionClustersInput
error
aurora-dsql-cluster-identifier-string
ClusterSummary identifier must be string type
$.components.schemas.ClusterSummary.properties.identifier