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-admin-base-url
Servers should reference api.demandbase.com.
$.servers[*].url
error
demandbase-admin-apikey-auth
Admin API should declare apiKey authentication.
$.components.securitySchemes
warn
demandbase-admin-users-resource
Admin API should expose /users for user management.
$.paths
warn
demandbase-admin-api-keys-resource
Admin API should expose /api-keys for key management.
$.paths

Spectral Ruleset

Raw ↑ 
extends:
  - spectral:oas
rules:
  demandbase-admin-base-url:
    description: Servers should reference api.demandbase.com.
    given: $.servers[*].url
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "demandbase\\.com"
  demandbase-admin-apikey-auth:
    description: Admin API should declare apiKey authentication.
    given: $.components.securitySchemes
    severity: error
    then:
      field: apiKeyAuth
      function: truthy
  demandbase-admin-users-resource:
    description: Admin API should expose /users for user management.
    given: $.paths
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "/users"
  demandbase-admin-api-keys-resource:
    description: Admin API should expose /api-keys for key management.
    given: $.paths
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "/api-keys"