Azure Service Bus · API Governance Rules

Azure Service Bus API Rules

Spectral linting rules defining API design standards and conventions for Azure Service Bus.

3 Rules warn 2 info 1

View Rules File View on GitHub

Rule Categories

no operation payload

Rules

info

payload-property-casing

Message payload properties should be camelCase (the dominant convention in this API).

$.components.schemas[*].properties

warn

operation-id-casing

Operation IDs should be camelCase (the dominant convention in this API).

$.channels[*][publish,subscribe].operationId

warn

no-empty-descriptions

Descriptions must not be empty strings.

$..description

Spectral Ruleset

# azure-service-bus — 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:
#   - payload-property-casing: camel @ 81% (n=21)
#   - operation-id-casing: camel @ 100% (n=4, v2)
extends:
  - spectral:asyncapi
rules:
  payload-property-casing:
    description: Message payload properties should be camelCase (the dominant convention in this API).
    severity: info
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: camel
  operation-id-casing:
    description: Operation IDs should be camelCase (the dominant convention in this API).
    severity: warn
    given: $.channels[*][publish,subscribe].operationId
    then:
      function: casing
      functionOptions:
        type: camel
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy