Clearstream · API Governance Rules
Clearstream API Rules
Spectral linting rules defining API design standards and conventions for Clearstream.
11 Rules
error 3
warn 8
Rule Categories
clearstream
Rules
error
clearstream-info-contact
API contact information must be present.
$.info
warn
clearstream-info-license
API license must be declared.
$.info
warn
clearstream-info-iso-version
Info description should reference ISO 15022 or ISO 20022.
$.info.description
error
clearstream-server-https
All server URLs must use HTTPS.
$.servers[*].url
warn
clearstream-server-domain
Server URLs must point at a clearstream.com host.
$.servers[*].url
warn
clearstream-operation-tags
Every operation must declare at least one tag.
$.paths[*][get,post,put,patch,delete]
warn
clearstream-operation-summary
Every operation must include a short summary.
$.paths[*][get,post,put,patch,delete]
error
clearstream-operation-id
Every operation must declare a unique operationId.
$.paths[*][get,post,put,patch,delete]
warn
clearstream-error-responses
Mutating operations should declare 4xx error responses.
$.paths[*][post,put,patch,delete].responses
warn
clearstream-bic-format
Counterparty BIC parameters should be 8 or 11 character ISO 9362 BICs.
$.paths[*][*].parameters[?(@.name && @.name.match(/bic/i))].schema
warn
clearstream-isin-format
ISIN parameters should be 12-character ISO 6166 identifiers.
$.paths[*][*].parameters[?(@.name && @.name.match(/isin/i))].schema