Dell Servers · API Governance Rules

Dell Servers API Rules

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

5 Rules error 1 warn 4

View Rules File View on GitHub

Rule Categories

dell

Rules

warn

dell-ome-server

Servers should reference the OpenManage Enterprise /api base path.

$.servers[*].url

error

dell-ome-devices-path

API should expose the DeviceService/Devices collection.

$.paths

warn

dell-ome-jobs-path

API should expose the JobService/Jobs collection.

$.paths

warn

dell-ome-operation-id

Operations should declare an operationId.

$.paths[*][*]

warn

dell-ome-tags

Operations should include at least one tag.

$.paths[*][*]

Spectral Ruleset

extends:
  - spectral:oas
rules:
  dell-ome-server:
    description: Servers should reference the OpenManage Enterprise /api base path.
    given: $.servers[*].url
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "/api"
  dell-ome-devices-path:
    description: API should expose the DeviceService/Devices collection.
    given: $.paths
    severity: error
    then:
      function: pattern
      functionOptions:
        match: "DeviceService/Devices"
  dell-ome-jobs-path:
    description: API should expose the JobService/Jobs collection.
    given: $.paths
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "JobService/Jobs"
  dell-ome-operation-id:
    description: Operations should declare an operationId.
    given: $.paths[*][*]
    severity: warn
    then:
      field: operationId
      function: truthy
  dell-ome-tags:
    description: Operations should include at least one tag.
    given: $.paths[*][*]
    severity: warn
    then:
      field: tags
      function: truthy