BlackRock · API Governance Rules

BlackRock API Rules

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

5 Rules warn 5

blackrock

warn

blackrock-portfolio-id-required

Portfolio requests must include a portfolioId field

$.components.schemas.*.properties

warn

blackrock-date-format

Date fields must use ISO 8601 date format

$.components.schemas[*].properties[?(@.description =~ /date/i)]

warn

blackrock-currency-iso

Currency fields must be documented as ISO 4217

$.components.schemas[*].properties.currency

warn

blackrock-operations-have-summary

All API operations must include a summary

$.paths[*][*]

warn

blackrock-security-defined

API must define at least one security scheme

$.components.securitySchemes