Bringg · API Governance Rules

Bringg API Rules

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

2 Rules warn 2
View Rules File View on GitHub

Rule Categories

message no

Rules

warn
message-name-casing
Message names should be PascalCase (the dominant convention in this API).
$.components.messages
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description

Spectral Ruleset

Raw ↑ 
# bringg — 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:
#   - message-name-casing: pascal @ 100% (n=45)
extends:
  - spectral:asyncapi
rules:
  message-name-casing:
    description: Message names should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.components.messages
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: pascal
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy