Gorgias · API Governance Rules

Gorgias API Rules

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

5 Rules error 1 warn 4

View Rules File View on GitHub

Rule Categories

channel no operation payload server

Rules

error

server-secure-protocol

Servers should use a secure protocol (this API's convention).

$.servers[*].protocol

warn

channel-key-casing

Channel names should be kebab-case (the dominant convention in this API).

$.channels

warn

payload-property-casing

Message payload properties should be snake_case (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

# gorgias — 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:
#   - server-secure-protocol: 100% of servers already secure
#   - channel-key-casing: kebab @ 100% (n=8)
#   - payload-property-casing: snake @ 100% (n=49)
#   - operation-id-casing: camel @ 100% (n=8, v2)
extends:
  - spectral:asyncapi
rules:
  server-secure-protocol:
    description: Servers should use a secure protocol (this API's convention).
    severity: error
    given: $.servers[*].protocol
    then:
      function: pattern
      functionOptions:
        match: ^(amqps|https|ibmmq|jms|kafka-secure|mqtts|secure-mqtt|stomps|wss)$
  channel-key-casing:
    description: Channel names should be kebab-case (the dominant convention in this API).
    severity: warn
    given: $.channels
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: kebab
  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
  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