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

View Rules File View on GitHub

Rule Categories

citizens

Rules

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

Spectral Ruleset

extends:
  - spectral:oas
rules:
  citizens-info-contact:
    description: API info MUST contain a contact email or URL.
    severity: warn
    given: $.info
    then:
      field: contact
      function: truthy
  citizens-https-only:
    description: All Citizens Financial API servers MUST use HTTPS.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: '^https://'
  citizens-operation-id:
    description: Operations MUST have an operationId.
    severity: error
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: operationId
      function: truthy
  citizens-tag-required:
    description: Operations MUST be tagged for product domain grouping.
    severity: warn
    given: $.paths[*][get,post,put,delete,patch].tags
    then:
      function: truthy
  citizens-security-required:
    description: API MUST define OAuth 2.0 or other security schemes.
    severity: error
    given: $.components.securitySchemes
    then:
      function: truthy
  citizens-server-url:
    description: API MUST declare at least one server URL.
    severity: error
    given: $.servers
    then:
      function: truthy