Dana · API Governance Rules

Dana API Rules

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

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

Rule Categories

dana

Rules

warn
dana-info-contact
API info should include a contact for Dana's developer relations team.
$.info
warn
dana-base-url
Servers should reference the api.danaaftermarket.com base URL.
$.servers[*].url
error
dana-api-key-security
API should declare an X-API-Key apiKey security scheme.
$.components.securitySchemes
warn
dana-operation-tags
Operations should be tagged Parts, Availability, Pricing, Orders, or Shipping.
$.paths[*][*]
warn
dana-part-number-required
Endpoints touching a single part must accept partNumber as a path or query parameter.
$.paths

Spectral Ruleset

Raw ↑ 
extends:
  - spectral:oas
rules:
  dana-info-contact:
    description: API info should include a contact for Dana's developer relations team.
    given: $.info
    severity: warn
    then:
      field: contact
      function: truthy
  dana-base-url:
    description: Servers should reference the api.danaaftermarket.com base URL.
    given: $.servers[*].url
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "danaaftermarket\\.com"
  dana-api-key-security:
    description: API should declare an X-API-Key apiKey security scheme.
    given: $.components.securitySchemes
    severity: error
    then:
      field: apiKey
      function: truthy
  dana-operation-tags:
    description: Operations should be tagged Parts, Availability, Pricing, Orders, or Shipping.
    given: $.paths[*][*]
    severity: warn
    then:
      field: tags
      function: truthy
  dana-part-number-required:
    description: Endpoints touching a single part must accept partNumber as a path or query parameter.
    given: $.paths
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "partNumber"