Filevine · API Governance Rules

Filevine API Rules

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

6 Rules error 1 warn 5
View Rules File View on GitHub

Rule Categories

channel message no operation 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 PascalCase (the dominant convention in this API).
$.channels
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

Raw ↑ 
# filevine — 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: pascal @ 100% (n=8)
#   - message-name-casing: pascal @ 100% (n=6)
#   - operation-id-casing: camel @ 100% (n=8, v3)
#   - message-payload-defined: 100% adherence
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 PascalCase (the dominant convention in this API).
    severity: warn
    given: $.channels
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: pascal
  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