Rulebase · API Governance Rules
Rulebase API Rules
Spectral linting rules defining API design standards and conventions for Rulebase.
7 Rules
error 3
warn 2
info 2
Generated by API Evangelist
Written by API Evangelist tooling for Rulebase's APIs. It is a starting point, not a ruleset Rulebase publishes or enforces.
Rule Categories
operation
operationid
path
response
write
Rules
error
operationid-casing-camel
operationIds are camelCase (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete].operationId
warn
operation-has-success-response
Every operation declares a 2xx response (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete].responses
info
operation-declares-4xx
Every operation declares at least one 4xx response (measured: 85% 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[*]~
info
write-declares-request-body
POST and PUT declare a request body (measured: 81% of this contract)
$.paths[*][post,put]
warn
response-media-type
Responses are served as application/json (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete].responses[*].content
Spectral Ruleset
Work with this as data
Every ruleset here is available over the APIs.io API and to AI agents over MCP.