Citizens Financial · API Governance Rules

Citizens Financial API Rules

Spectral linting rules defining API design standards and conventions for Citizens Financial.

6 Rules error 4 warn 2

citizens

warn

citizens-info-contact

API info MUST contain a contact email or URL.

$.info

error

citizens-https-only

All Citizens Financial API servers MUST use HTTPS.

$.servers[*].url

error

citizens-operation-id

Operations MUST have an operationId.

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

warn

citizens-tag-required

Operations MUST be tagged for product domain grouping.

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

error

citizens-security-required

API MUST define OAuth 2.0 or other security schemes.

$.components.securitySchemes

error

citizens-server-url

API MUST declare at least one server URL.

$.servers