Demandbase · API Governance Rules

Demandbase API Rules

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

4 Rules error 1 warn 3

View Rules File View on GitHub

Rule Categories

demandbase

Rules

warn

demandbase-engagement-base-url

Servers should reference api.demandbase.com.

$.servers[*].url

error

demandbase-engagement-apikey-auth

Engagement API should declare apiKey authentication.

$.components.securitySchemes

warn

demandbase-engagement-account-resource

Engagement API should expose /accounts/{accountId}/engagement.

$.paths

warn

demandbase-engagement-webhooks

Engagement API should expose /webhooks.

$.paths

Spectral Ruleset

extends:
  - spectral:oas
rules:
  demandbase-engagement-base-url:
    description: Servers should reference api.demandbase.com.
    given: $.servers[*].url
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "demandbase\\.com"
  demandbase-engagement-apikey-auth:
    description: Engagement API should declare apiKey authentication.
    given: $.components.securitySchemes
    severity: error
    then:
      field: apiKeyAuth
      function: truthy
  demandbase-engagement-account-resource:
    description: Engagement API should expose /accounts/{accountId}/engagement.
    given: $.paths
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "engagement"
  demandbase-engagement-webhooks:
    description: Engagement API should expose /webhooks.
    given: $.paths
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "/webhooks"