Citigroup · API Governance Rules

Citigroup API Rules

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

6 Rules error 3 warn 3

View Rules File View on GitHub

Rule Categories

citi

Rules

error

citi-https-only

All Citi API servers MUST use HTTPS.

$.servers[*].url

error

citi-oauth-required

Citi APIs MUST declare OAuth 2.0 security schemes.

$.components.securitySchemes

error

citi-operation-id

Operations MUST have an operationId.

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

warn

citi-tag-required

Operations MUST be tagged for product domain grouping.

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

warn

citi-summary-required

Operations MUST have a summary.

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

warn

citi-info-contact

API info MUST contain a contact for security disclosures.

$.info

Spectral Ruleset

extends:
  - spectral:oas
rules:
  citi-https-only:
    description: All Citi API servers MUST use HTTPS.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: '^https://'
  citi-oauth-required:
    description: Citi APIs MUST declare OAuth 2.0 security schemes.
    severity: error
    given: $.components.securitySchemes
    then:
      function: truthy
  citi-operation-id:
    description: Operations MUST have an operationId.
    severity: error
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: operationId
      function: truthy
  citi-tag-required:
    description: Operations MUST be tagged for product domain grouping.
    severity: warn
    given: $.paths[*][get,post,put,delete,patch].tags
    then:
      function: truthy
  citi-summary-required:
    description: Operations MUST have a summary.
    severity: warn
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: summary
      function: truthy
  citi-info-contact:
    description: API info MUST contain a contact for security disclosures.
    severity: warn
    given: $.info
    then:
      field: contact
      function: truthy