Avalara · API Governance Rules

Avalara API Rules

Spectral linting rules defining API design standards and conventions for Avalara.

3 Rules warn 3
View Rules File View on GitHub

Rule Categories

no payload security

Rules

warn
security-schemes-defined
Security schemes should be defined in components.
$.components
warn
payload-property-casing
Message payload properties should be snake_case (the dominant convention in this API).
$.components.schemas[*].properties
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description

Spectral Ruleset

Raw ↑ 
# avalara — AsyncAPI Spectral ruleset (strengthened)
# Plain Spectral. Rules measured from this provider's own AsyncAPI event
# conventions by strengthen_asyncapi.py, then self-validated against the spec.
#
# Provenance:
#   - security-schemes: ['awsSignatureV4']
#   - payload-property-casing: snake @ 100% (n=12)
extends:
  - spectral:asyncapi
rules:
  security-schemes-defined:
    description: Security schemes should be defined in components.
    severity: warn
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  payload-property-casing:
    description: Message payload properties should be snake_case (the dominant convention in this API).
    severity: warn
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: snake
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy