Bloom Credit · API Governance Rules
Bloom Credit API Rules
Spectral linting rules defining API design standards and conventions for Bloom Credit.
30 Rules
error 11
warn 14
info 5
Rule Categories
bloom
Rules
error
bloom-credit-info-title
API must have a title
$.info
error
bloom-credit-info-description
API must have a description
$.info
error
bloom-credit-info-version
API must have a version
$.info
warn
bloom-credit-info-contact
API must have contact information
$.info
error
bloom-credit-servers-exist
API must have at least one server defined
$
error
bloom-credit-server-https
All servers must use HTTPS
$.servers[*]
warn
bloom-credit-server-description
Each server must have a description
$.servers[*]
warn
bloom-credit-path-kebab-case
Path segments must use kebab-case
$.paths[*]~
error
bloom-credit-path-no-trailing-slash
Paths must not have trailing slashes
$.paths[*]~
error
bloom-credit-operation-id-exists
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete,head,options,trace]
warn
bloom-credit-operation-id-kebab-case
OperationId must use kebab-case
$.paths[*][get,post,put,patch,delete,head,options,trace]
error
bloom-credit-operation-summary-exists
Every operation must have a summary
$.paths[*][get,post,put,patch,delete,head,options,trace]
warn
bloom-credit-operation-summary-prefix
Operation summaries must start with Bloom Credit
$.paths[*][get,post,put,patch,delete,head,options,trace]
warn
bloom-credit-operation-description-exists
Every operation must have a description
$.paths[*][get,post,put,patch,delete,head,options,trace]
warn
bloom-credit-operation-tags
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete,head,options,trace]
warn
bloom-credit-parameter-description
All parameters must have a description
$.paths[*][*].parameters[*]
error
bloom-credit-parameter-schema
All parameters must have a schema
$.paths[*][*].parameters[*]
error
bloom-credit-response-success-exists
Operations must have at least one 2xx response
$.paths[*][get,post,put,patch,delete]
warn
bloom-credit-response-schema-exists
Success responses must have a content schema
$.paths[*][*].responses[200,201].content[*]
warn
bloom-credit-response-examples
Responses should include examples
$.paths[*][*].responses[200,201].content[*]
error
bloom-credit-security-scheme-defined
API must define security schemes
$.components
warn
bloom-credit-global-security
API should have global security defined
$
info
bloom-credit-apikey-auth
API should use API key authentication via X-API-Key header
$.components.securitySchemes[*]
warn
bloom-credit-schema-type
All schema objects must have a type
$.components.schemas[*]
warn
bloom-credit-schema-description
All schema components must have a description
$.components.schemas[*]
info
bloom-credit-property-description
Schema properties should have descriptions
$.components.schemas[*].properties[*]
info
bloom-credit-consumer-id-path
Consumer endpoints should be nested under /consumers/{consumer_id}
$.paths[/consumers/{consumer_id}*]~
info
bloom-credit-bureau-enum
Bureau fields should use valid bureau names
$.components.schemas[*].properties.bureau.enum
info
bloom-credit-score-range
Credit score schemas should define min/max range
$.components.schemas.CreditScore.properties.score
warn
bloom-credit-sandbox-server
API should have a sandbox server for testing
$.servers