Citigroup · API Governance Rules
Citigroup API Rules
Spectral linting rules defining API design standards and conventions for Citigroup.
6 Rules
error 3
warn 3
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