WebSockets · API Governance Rules

WebSockets API Rules

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

4 Rules warn 4

View Rules File View on GitHub

Rule Categories

message no operation

Rules

warn

message-name-casing

Message names should be PascalCase (the dominant convention in this API).

$.components.messages

warn

operation-id-casing

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

$.operations

warn

message-payload-defined

Messages should define a payload schema (set on 100% of this API's messages).

$.components.messages[*]

warn

no-empty-descriptions

Descriptions must not be empty strings.

$..description

Spectral Ruleset

# websockets — 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=5)
#   - operation-id-casing: camel @ 100% (n=5, v3)
#   - message-payload-defined: 100% adherence
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
  operation-id-casing:
    description: Operation names should be camelCase (the dominant convention in this API).
    severity: warn
    given: $.operations
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: camel
  message-payload-defined:
    description: Messages should define a payload schema (set on 100% of this API's messages).
    severity: warn
    given: $.components.messages[*]
    then:
      field: payload
      function: truthy
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy