Bria8f2b · API Governance Rules
Bria8f2b API Rules
Spectral linting rules defining API design standards and conventions for Bria8f2b.
14 Rules
error 10
warn 2
info 2
Rule Categories
info
operation
path
response
servers
write
Rules
error
operation-has-operationid
Every operation declares an operationId (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
error
operation-has-summary
Every operation has a summary (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
error
operation-has-description
Every operation has a description (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
error
operation-has-tags
Every operation is tagged (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
error
operation-has-success-response
Every operation declares a 2xx response (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete].responses
warn
operation-declares-4xx
Every operation declares at least one 4xx response (measured: 97% of this contract)
$.paths[*][get,post,put,patch,delete].responses
info
operation-declares-429
Every operation declares 429 (rate limited) (measured: 88% of this contract)
$.paths[*][get,post,put,patch,delete].responses
error
path-no-trailing-slash
Paths carry no trailing slash (measured: 100% of this contract)
$.paths[*]~
error
path-params-in-braces
Path parameters use {braces}, not :colon (measured: 100% of this contract)
$.paths[*]~
error
servers-https
Servers are https (measured: 100% of this contract)
$.servers[*].url
info
write-declares-request-body
POST and PUT declare a request body (measured: 84% of this contract)
$.paths[*][post,put]
warn
response-media-type
Responses are served as application/json (measured: 91% of this contract)
$.paths[*][get,post,put,patch,delete].responses[*].content
error
info-has-description
The contract's info block carries a description (measured: 100% of this contract)
$.info
error
info-has-contact-or-terms
The contract's info block names a contact or terms of service (measured: 100% of this contract)
$.info
Spectral Ruleset
Work with this as data
Every ruleset here is available over the APIs.io API and to AI agents over MCP.