Bloomberg AIM · API Governance Rules
Bloomberg AIM API Rules
Spectral linting rules defining API design standards and conventions for Bloomberg AIM.
7 Rules
error 7
Rule Categories
info
no
operation
response
Rules
error
info-title-required
Info title must be present
$.info
error
info-description-required
Info description must be present
$.info
error
operation-operationid-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
error
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,patch,delete]
error
response-description-required
Every response must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
error
no-empty-descriptions
Descriptions must not be empty
$..description