Amazon Aurora · API Governance Rules
Amazon Aurora API Rules
Spectral linting rules defining API design standards and conventions for Amazon Aurora.
14 Rules
error 8
warn 6
Rule Categories
aurora
Rules
warn
aurora-operation-id-camel-case
All operationIds must be camelCase
$.paths[*][*].operationId
warn
aurora-summary-prefix
All operation summaries must start with Amazon Aurora
$.paths[*][*].summary
warn
aurora-has-tags
All operations must have tags
$.paths[*][*]
error
aurora-response-200
All operations must have a 200 response
$.paths[*][*].responses
error
aurora-create-cluster-required
CreateDBClusterInput must require DBClusterIdentifier and Engine
$.components.schemas.CreateDBClusterInput
error
aurora-engine-enum
Engine must use valid enum values for Aurora
$.components.schemas.CreateDBClusterInput.properties.Engine
error
aurora-endpoint-type-enum
CreateDBClusterEndpoint EndpointType must use valid enum values
$.components.schemas.CreateDBClusterEndpointInput.properties.EndpointType
error
aurora-security-sigv4
API must use sigv4 security scheme
$.security[*]
warn
aurora-server-url-fixed
Server URL must be fixed without variables
$.servers[*]
warn
aurora-example-microcks-default
All examples must have x-microcks-default set to true
$.paths[*][*].responses[*].content[*].examples.default
error
aurora-db-cluster-identifier-string
DBCluster DBClusterIdentifier must be string type
$.components.schemas.DBCluster.properties.DBClusterIdentifier
error
aurora-filter-values-array
Filter Values must be an array
$.components.schemas.Filter.properties.Values
error
aurora-global-cluster-identifier-string
GlobalCluster GlobalClusterIdentifier must be string type
$.components.schemas.GlobalCluster.properties.GlobalClusterIdentifier
warn
aurora-snapshot-status-defined
DBClusterSnapshot Status must be defined
$.components.schemas.DBClusterSnapshot.properties