Blackstone · API Governance Rules

Blackstone API Rules

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

5 Rules warn 5
View Rules File View on GitHub

Rule Categories

blackstone

Rules

warn
blackstone-fund-strategy-enum
Fund strategy must be one of the defined values
$.components.schemas.Fund.properties.strategy
warn
blackstone-currency-required
Financial records must include a currency field
$.components.schemas[*].properties
warn
blackstone-date-iso-format
Date fields must use ISO 8601 format
$.components.schemas[*].properties[?(@.description =~ /date/i)]
warn
blackstone-operations-have-descriptions
All API operations should include descriptions
$.paths[*][*]
warn
blackstone-ids-are-strings
All ID fields should be of type string
$.components.schemas[*].properties[?(@.description =~ /identifier|id/i)]