Dell Technologies · API Governance Rules

Dell Technologies API Rules

Spectral linting rules defining API design standards and conventions for Dell Technologies.

5 Rules error 1 warn 3 info 1
View Rules File View on GitHub

Rule Categories

dell

Rules

warn
dell-info-contact
API info should include Dell developer support contact.
$.info
warn
dell-base-url
Servers should reference developer.dell.com.
$.servers[*].url
error
dell-bearer-auth
API should declare bearer-token authentication.
$.components.securitySchemes
warn
dell-operation-tags
Operations should be tagged with infrastructure categories.
$.paths[*][*]
info
dell-status-resource
API should expose a /status resource for health checks.
$.paths

Spectral Ruleset

Raw ↑ 
extends:
  - spectral:oas
rules:
  dell-info-contact:
    description: API info should include Dell developer support contact.
    given: $.info
    severity: warn
    then:
      field: contact
      function: truthy
  dell-base-url:
    description: Servers should reference developer.dell.com.
    given: $.servers[*].url
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "developer\\.dell\\.com"
  dell-bearer-auth:
    description: API should declare bearer-token authentication.
    given: $.components.securitySchemes
    severity: error
    then:
      field: bearerAuth
      function: truthy
  dell-operation-tags:
    description: Operations should be tagged with infrastructure categories.
    given: $.paths[*][*]
    severity: warn
    then:
      field: tags
      function: truthy
  dell-status-resource:
    description: API should expose a /status resource for health checks.
    given: $.paths
    severity: info
    then:
      function: pattern
      functionOptions:
        match: "/status"