Blockfrost · API Governance Rules
Blockfrost API Rules
Spectral linting rules defining API design standards and conventions for Blockfrost.
30 Rules
error 13
warn 10
info 7
Rule Categories
external
get
info
no
openapi
operation
pagination
parameter
paths
response
schema
security
servers
tags
Rules
warn
info-title-prefix
API title must start with "Blockfrost"
$.info.title
error
info-description-required
Info object must have a description
$.info
error
info-version-required
Info object must have a version
$.info
warn
info-contact-required
Info object should have contact information
$.info
info
info-license-required
Info object should have license information
$.info
error
openapi-version
Must use OpenAPI 3.x
$
error
servers-defined
At least one server must be defined
$
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
warn
paths-kebab-case
Path segments must use lowercase with underscores or kebab-case
$.paths[*]~
warn
paths-no-trailing-slash
Paths must not have trailing slashes
$.paths[*]~
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-prefix
Operation summaries must start with "Blockfrost"
$.paths[*][get,post,put,patch,delete].summary
warn
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
info
operation-id-snake-case
operationId should use snake_case
$.paths[*][get,post,put,patch,delete].operationId
warn
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
Every parameter must have a description
$.paths[*][get,post,put,patch,delete].parameters[*]
error
parameter-schema-required
Every parameter must define a schema
$.paths[*][get,post,put,patch,delete].parameters[*]
info
pagination-count-or-limit
List endpoints should support count pagination parameter
$.paths[*].get
error
response-success-required
Every operation must define at least one 2xx response
$.paths[*][get,post,put,patch,delete]
info
response-400-defined
Operations should define a 400 Bad Request response
$.paths[*][get,post,put,patch,delete].responses
info
response-403-defined
Operations should define a 403 Forbidden response
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
Every response must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
warn
schema-description-required
Top-level schemas must have a description
$.components.schemas[*]
error
security-schemes-defined
At least one security scheme must be defined
$.components
warn
security-global-defined
Global security must be defined
$
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
tags-global-defined
Global tags array should be defined
$
info
external-docs-encouraged
External documentation should be provided
$