Barclays · API Governance Rules

Barclays API Rules

Spectral linting rules defining API design standards and conventions for Barclays.

7 Rules error 5 warn 1 info 1
View Rules File View on GitHub

Rule Categories

barclays

Rules

error
barclays-api-has-documentation
All Barclays API entries must have a Documentation property.
$.apis[*]
error
barclays-api-has-description
All Barclays API entries must have a description.
$.apis[*]
error
barclays-api-has-name
All Barclays API entries must have a name.
$.apis[*]
error
barclays-api-has-human-url
All Barclays API entries must have a humanURL.
$.apis[*]
warn
barclays-api-has-tags
All Barclays API entries must have tags.
$.apis[*]
info
barclays-open-banking-has-psd2-tag
Barclays Open Banking APIs should be tagged with Open Banking or PSD2.
$.apis[?(@.name =~ /Open Banking|Account|Payment|Confirmation/i)]
error
barclays-apis-json-has-description
Barclays APIs.json must have a description.
$