Black Knight (Acquired by ICE — Now ICE Mortgage Technology) · API Governance Rules

Black Knight (Acquired by ICE — Now ICE Mortgage Technology) API Rules

Spectral linting rules defining API design standards and conventions for Black Knight (Acquired by ICE — Now ICE Mortgage Technology).

Black Knight (Acquired by ICE — Now ICE Mortgage Technology) API Rules is a Spectral governance ruleset published by Black Knight (Acquired by ICE — Now ICE Mortgage Technology) on the APIs.io network, containing 9 lint rules.

The ruleset includes 4 error-severity rules, 4 warning-severity rules, and 1 info-severity rule.

Tagged areas include Mortgage Technology, Loan Servicing, Loan Origination, Secondary Marketing, and Default Management.

Rulesets can be applied to your own OpenAPI specs via Spectral to enforce the same governance standards.

9 Rules error 4 warn 4 info 1
View Rules File View on GitHub

Rule Categories

black

Rules

error
black-knight-info-title-required
All ICE Mortgage Technology / Black Knight specs must have a clear info.title naming the API and surface.
$.info
error
black-knight-info-description-required
Specs must include a description noting whether the API is MSP DX, Servicing, Encompass, or Optimal Blue, and the current ICE / Constellation ownership.
$.info
warn
black-knight-info-contact-required
Provide an info.contact pointing to developer.ice.com, developer.icemortgagetechnology.com, or digitalmarketplace.optimalblue.com.
$.info
error
black-knight-oauth-flow-required
ICE / Optimal Blue APIs are OAuth 2.0 only; specs must declare an oauth2 security scheme.
$.components.securitySchemes
warn
black-knight-operation-id-camelcase
operationId values should be camelCase (e.g., getMspLoan, createPromiseToPay, searchOptimalBluePricing).
$.paths.*.*.operationId
warn
black-knight-summary-title-case
Operation summaries must use Title Case (e.g., "Get MSP Loan By Number").
$.paths.*.*.summary
error
black-knight-tags-required
Every operation must carry at least one tag (Loan Servicing, Default Management, Loss Mitigation, Secondary Marketing, etc.).
$.paths.*.*
info
black-knight-loan-number-pattern
MSP loan numbers should be documented as 10-digit zero-padded strings.
$.components.schemas.*.properties.loanNumber
warn
black-knight-error-responses-present
Operations must document at least one 4xx error response.
$.paths.*.*.responses

Spectral Ruleset

Raw ↑ 
extends: spectral:oas
documentationUrl: https://raw.githubusercontent.com/api-evangelist/black-knight/main/rules/black-knight-rules.yml

rules:
  black-knight-info-title-required:
    description: All ICE Mortgage Technology / Black Knight specs must have a clear info.title naming the API and surface.
    severity: error
    given: $.info
    then:
      field: title
      function: truthy

  black-knight-info-description-required:
    description: Specs must include a description noting whether the API is MSP DX, Servicing, Encompass, or Optimal Blue, and the current ICE / Constellation ownership.
    severity: error
    given: $.info
    then:
      field: description
      function: truthy

  black-knight-info-contact-required:
    description: Provide an info.contact pointing to developer.ice.com, developer.icemortgagetechnology.com, or digitalmarketplace.optimalblue.com.
    severity: warn
    given: $.info
    then:
      field: contact
      function: truthy

  black-knight-oauth-flow-required:
    description: ICE / Optimal Blue APIs are OAuth 2.0 only; specs must declare an oauth2 security scheme.
    severity: error
    given: $.components.securitySchemes
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          patternProperties:
            "^.*$":
              type: object
              properties:
                type:
                  enum: [oauth2, http, openIdConnect]

  black-knight-operation-id-camelcase:
    description: operationId values should be camelCase (e.g., getMspLoan, createPromiseToPay, searchOptimalBluePricing).
    severity: warn
    given: $.paths.*.*.operationId
    then:
      function: casing
      functionOptions:
        type: camel

  black-knight-summary-title-case:
    description: Operation summaries must use Title Case (e.g., "Get MSP Loan By Number").
    severity: warn
    given: $.paths.*.*.summary
    then:
      function: pattern
      functionOptions:
        match: "^([A-Z][a-zA-Z0-9]*)( [A-Z][a-zA-Z0-9]*)*$"

  black-knight-tags-required:
    description: Every operation must carry at least one tag (Loan Servicing, Default Management, Loss Mitigation, Secondary Marketing, etc.).
    severity: error
    given: $.paths.*.*
    then:
      field: tags
      function: truthy

  black-knight-loan-number-pattern:
    description: MSP loan numbers should be documented as 10-digit zero-padded strings.
    severity: info
    given: $.components.schemas.*.properties.loanNumber
    then:
      field: pattern
      function: truthy

  black-knight-error-responses-present:
    description: Operations must document at least one 4xx error response.
    severity: warn
    given: $.paths.*.*.responses
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          patternProperties:
            "^4[0-9]{2}$":
              type: object
          minProperties: 1