Burs-IA · API Governance Rules
Burs-IA API Rules
Spectral linting rules defining API design standards and conventions for Burs-IA.
12 Rules
error 10
warn 1
info 1
Generated by API Evangelist
Written by API Evangelist tooling for Burs-IA's APIs. It is a starting point, not a ruleset Burs-IA publishes or enforces.
Rule Categories
info
operation
path
server
servers
Rules
error
operation-has-summary
Every operation has a summary (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
warn
path-segment-casing-kebab
Path segments are kebab case (measured: 94% of this contract)
$.paths[*]~
error
path-no-trailing-slash
Paths carry no trailing slash (measured: 100% of this contract)
$.paths[*]~
info
path-params-in-braces
Path parameters use {braces}, not :colon (measured: 88% of this contract)
$.paths[*]~
error
servers-https
Servers are https (measured: 100% of this contract)
$.servers[*].url
error
info-title-present
Info declares title (measured: 100% of this contract)
$.info
error
info-version-present
Info declares version (measured: 100% of this contract)
$.info
error
info-version-semver
info.version is numeric (measured: 100% of this contract)
$.info.version
error
server-url-present
Server declares url (measured: 100% of this contract)
$.servers[*]
error
server-url-https
Server.url is https (measured: 100% of this contract)
$.servers[*].url
error
operation-summary-present
Operation declares summary (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-summary-min-length
Operation.summary runs at least 15 characters (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].summary
Spectral Ruleset
Work with this as data
Every ruleset here is available over the APIs.io API and to AI agents over MCP.