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-idrac-redfish-server

Servers should reference the Redfish service root path.

$.servers[*].url

error

dell-idrac-redfish-systems-path

API should expose the /Systems collection.

$.paths

warn

dell-idrac-redfish-chassis-path

API should expose the /Chassis collection.

$.paths

warn

dell-idrac-redfish-operation-id

Operations should declare an operationId.

$.paths[*][*]

warn

dell-idrac-redfish-tags

Operations should include at least one tag.

$.paths[*][*]

Spectral Ruleset

extends:
  - spectral:oas
rules:
  dell-idrac-redfish-server:
    description: Servers should reference the Redfish service root path.
    given: $.servers[*].url
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "/redfish/v1"
  dell-idrac-redfish-systems-path:
    description: API should expose the /Systems collection.
    given: $.paths
    severity: error
    then:
      function: pattern
      functionOptions:
        match: "/Systems"
  dell-idrac-redfish-chassis-path:
    description: API should expose the /Chassis collection.
    given: $.paths
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "/Chassis"
  dell-idrac-redfish-operation-id:
    description: Operations should declare an operationId.
    given: $.paths[*][*]
    severity: warn
    then:
      field: operationId
      function: truthy
  dell-idrac-redfish-tags:
    description: Operations should include at least one tag.
    given: $.paths[*][*]
    severity: warn
    then:
      field: tags
      function: truthy