Amazon Aurora · API Governance Rules

Amazon Aurora API Rules

Spectral linting rules defining API design standards and conventions for Amazon Aurora.

20 Rules error 9 warn 11
View Rules File View on GitHub

Rule Categories

aurora no schema security servers

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
error
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
warn
servers-expected-domain
Server URLs should be on the amazonaws.com domain.
$.servers[*].url
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
warn
schema-properties-casing
Schema properties should be PascalCase (the dominant convention in this API).
$.components.schemas[*].properties
warn
security-schemes-defined
Security schemes should be defined in components.
$.components
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description

Spectral Ruleset

Raw ↑
# amazon-aurora — Spectral ruleset (strengthened)
# Plain Spectral. Existing hand-authored rules preserved; measured rules added
# from this provider's own OpenAPI conventions by strengthen_ruleset.py,
# then self-validated against the spec.
#
# Provenance:
#   - servers-https-only: 100% of servers already https (error)
#   - servers-expected-domain: 1/1 servers on amazonaws.com
#   - operationid-casing: camel @ 100% (n=21)
#   - schema-names-casing: pascal @ 100% (n=54)
#   - schema-properties-casing: pascal @ 100% (n=199)
#   - security: global (root) — NOT emitting operation-security-required
#   - merge: kept 14 existing, added 6 measured, upgraded 0
#   - added: servers-https-only, servers-expected-domain, schema-names-casing, schema-properties-casing, security-schemes-defined, no-empty-descriptions
extends:
  - spectral:oas
rules:
  aurora-operation-id-camel-case:
    description: All operationIds must be camelCase
    message: '{{property}} must be camelCase'
    severity: warn
    given: $.paths[*][*].operationId
    then:
      function: pattern
      functionOptions:
        match: ^[a-z][a-zA-Z0-9]*$
  aurora-summary-prefix:
    description: All operation summaries must start with Amazon Aurora
    message: Summary must start with Amazon Aurora
    severity: warn
    given: $.paths[*][*].summary
    then:
      function: pattern
      functionOptions:
        match: ^Amazon Aurora
  aurora-has-tags:
    description: All operations must have tags
    message: Operation must have at least one tag
    severity: warn
    given: $.paths[*][*]
    then:
      field: tags
      function: truthy
  aurora-response-200:
    description: All operations must have a 200 response
    message: Operation must define a 200 response
    severity: error
    given: $.paths[*][*].responses
    then:
      field: '200'
      function: truthy
  aurora-create-cluster-required:
    description: CreateDBClusterInput must require DBClusterIdentifier and Engine
    message: CreateDBClusterInput must have required fields
    severity: error
    given: $.components.schemas.CreateDBClusterInput
    then:
      field: required
      function: truthy
  aurora-engine-enum:
    description: Engine must use valid enum values for Aurora
    message: Engine must be aurora-mysql or aurora-postgresql
    severity: error
    given: $.components.schemas.CreateDBClusterInput.properties.Engine
    then:
      field: enum
      function: truthy
  aurora-endpoint-type-enum:
    description: CreateDBClusterEndpoint EndpointType must use valid enum values
    message: EndpointType must be READER or ANY
    severity: error
    given: $.components.schemas.CreateDBClusterEndpointInput.properties.EndpointType
    then:
      field: enum
      function: truthy
  aurora-security-sigv4:
    description: API must use sigv4 security scheme
    message: Security must include sigv4
    severity: error
    given: $.security[*]
    then:
      field: sigv4
      function: defined
  aurora-server-url-fixed:
    description: Server URL must be fixed without variables
    message: Server URL must not use variables
    severity: warn
    given: $.servers[*]
    then:
      field: variables
      function: falsy
  aurora-example-microcks-default:
    description: All examples must have x-microcks-default set to true
    message: Example must have x-microcks-default true
    severity: warn
    given: $.paths[*][*].responses[*].content[*].examples.default
    then:
      field: x-microcks-default
      function: truthy
  aurora-db-cluster-identifier-string:
    description: DBCluster DBClusterIdentifier must be string type
    message: DBClusterIdentifier must be a string
    severity: error
    given: $.components.schemas.DBCluster.properties.DBClusterIdentifier
    then:
      field: type
      function: truthy
  aurora-filter-values-array:
    description: Filter Values must be an array
    message: Filter Values must be an array
    severity: error
    given: $.components.schemas.Filter.properties.Values
    then:
      field: type
      function: enumeration
      functionOptions:
        values:
        - array
  aurora-global-cluster-identifier-string:
    description: GlobalCluster GlobalClusterIdentifier must be string type
    message: GlobalClusterIdentifier must be a string
    severity: error
    given: $.components.schemas.GlobalCluster.properties.GlobalClusterIdentifier
    then:
      field: type
      function: truthy
  aurora-snapshot-status-defined:
    description: DBClusterSnapshot Status must be defined
    message: DBClusterSnapshot must have a Status property
    severity: warn
    given: $.components.schemas.DBClusterSnapshot.properties
    then:
      field: Status
      function: truthy
  servers-https-only:
    description: Server URLs must use HTTPS.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^https://
  servers-expected-domain:
    description: Server URLs should be on the amazonaws.com domain.
    severity: warn
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: amazonaws\.com
  schema-names-casing:
    description: Component schema names should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.components.schemas
    then:
      field: '@key'
      function: pattern
      functionOptions:
        match: ^[A-Z][A-Za-z0-9]*$
  schema-properties-casing:
    description: Schema properties should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: pattern
      functionOptions:
        match: ^[A-Z][A-Za-z0-9]*$
  security-schemes-defined:
    description: Security schemes should be defined in components.
    severity: warn
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy