Datadog APM · API Governance Rules

Datadog APM API Rules

Spectral linting rules defining API design standards and conventions for Datadog APM.

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

Rule Categories

datadog

Rules

warn
datadog-apm-info-contact
API info should provide a contact for Datadog support.
$.info
warn
datadog-apm-server-region
Servers should target one of the Datadog regional sites.
$.servers[*].url
warn
datadog-apm-api-version-prefix
Operation paths should be versioned under /api/v1 or /api/v2.
$.paths
error
datadog-apm-operation-tags
Every operation must declare at least one tag.
$.paths[*][*]
warn
datadog-apm-security-keys
Operations should require both API key and application key auth.
$.security

Spectral Ruleset

Raw ↑ 
extends:
  - spectral:oas
rules:
  datadog-apm-info-contact:
    description: API info should provide a contact for Datadog support.
    given: $.info
    severity: warn
    then:
      field: contact
      function: truthy
  datadog-apm-server-region:
    description: Servers should target one of the Datadog regional sites.
    given: $.servers[*].url
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "datadoghq\\.(com|eu)|datadoghq\\.com"
  datadog-apm-api-version-prefix:
    description: Operation paths should be versioned under /api/v1 or /api/v2.
    given: $.paths
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "^/api/v[12]"
  datadog-apm-operation-tags:
    description: Every operation must declare at least one tag.
    given: $.paths[*][*]
    severity: error
    then:
      field: tags
      function: truthy
  datadog-apm-security-keys:
    description: Operations should require both API key and application key auth.
    given: $.security
    severity: warn
    then:
      function: truthy