Jack Henry & Associates · API Governance Rules

Jack Henry & Associates API Rules

Spectral linting rules defining API design standards and conventions for Jack Henry & Associates.

Jack Henry & Associates API Rules is a Spectral governance ruleset published by Jack Henry & Associates on the APIs.io network, containing 3 lint rules.

The ruleset includes 2 error-severity rules and 1 warning-severity rule.

Tagged areas include Financial Services, Banking, Core Banking, Digital Banking, and Payments.

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

3 Rules error 2 warn 1

View Rules File View on GitHub

Rule Categories

jxchange

Rules

error

jxchange-paths-versioned

jXchange REST paths MUST live under /jxchange/v1.

$.paths.*~

warn

jxchange-summary-title-case

Operation summaries should use Title Case.

$.paths[*][get,post,put,delete,patch].summary

error

jxchange-routing-number-pattern

routingNumber properties MUST be 9 digits.

$..properties.routingNumber.pattern,$..properties.beneficiaryRoutingNumber.pattern

Spectral Ruleset

extends: [[spectral:oas, all]]
rules:
  jxchange-paths-versioned:
    description: jXchange REST paths MUST live under /jxchange/v1.
    given: $.paths.*~
    severity: error
    then:
      function: pattern
      functionOptions:
        match: '^/jxchange/v1/'
  jxchange-summary-title-case:
    description: Operation summaries should use Title Case.
    given: $.paths[*][get,post,put,delete,patch].summary
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: '^([A-Z][a-zA-Z0-9]*\s?)+$'
  jxchange-routing-number-pattern:
    description: routingNumber properties MUST be 9 digits.
    given: "$..properties.routingNumber.pattern,$..properties.beneficiaryRoutingNumber.pattern"
    severity: error
    then:
      function: pattern
      functionOptions:
        match: '\^\[0-9\]\{9\}\$'