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 1 error-severity rule and 2 warning-severity rules.

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 1 warn 2

View Rules File View on GitHub

Rule Categories

banno

Rules

error

banno-admin-paths-versioned

All Banno Admin paths MUST live under /a/mobile/api/v0.

$.paths.*~

warn

banno-admin-institution-scoped

Admin endpoints SHOULD be scoped under /institutions/{institutionId}/ for multi-tenant isolation.

$.paths.*~

warn

banno-admin-summary-title-case

Operation summaries should use Title Case.

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

Spectral Ruleset

extends: [[spectral:oas, all]]
rules:
  banno-admin-paths-versioned:
    description: All Banno Admin paths MUST live under /a/mobile/api/v0.
    given: $.paths.*~
    severity: error
    then:
      function: pattern
      functionOptions:
        match: '^/a/mobile/api/v0/'
  banno-admin-institution-scoped:
    description: Admin endpoints SHOULD be scoped under /institutions/{institutionId}/ for multi-tenant isolation.
    given: $.paths.*~
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: '/institutions/\{institutionId\}/'
  banno-admin-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?)+$'