Demandbase · API Governance Rules

Demandbase API Rules

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

3 Rules error 1 warn 2

View Rules File View on GitHub

Rule Categories

demandbase

Rules

warn

demandbase-export-base-url

Servers should reference api.demandbase.com.

$.servers[*].url

error

demandbase-export-apikey-auth

Data Export API should declare apiKey authentication.

$.components.securitySchemes

warn

demandbase-export-jobs-resource

Export API should expose /export/v1/jobs.

$.paths

Spectral Ruleset

extends:
  - spectral:oas
rules:
  demandbase-export-base-url:
    description: Servers should reference api.demandbase.com.
    given: $.servers[*].url
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "demandbase\\.com"
  demandbase-export-apikey-auth:
    description: Data Export API should declare apiKey authentication.
    given: $.components.securitySchemes
    severity: error
    then:
      field: apiKeyAuth
      function: truthy
  demandbase-export-jobs-resource:
    description: Export API should expose /export/v1/jobs.
    given: $.paths
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "/export/v1/jobs"