searchpipe-tech · API Governance Rules
searchpipe-tech API Rules
Spectral linting rules defining API design standards and conventions for searchpipe-tech.
10 Rules
error 5
warn 2
info 3
Generated by API Evangelist
Written by API Evangelist tooling for searchpipe-tech's APIs. It is a starting point, not a ruleset searchpipe-tech publishes or enforces.
Rule Categories
operation
operationid
path
schema
Rules
error
operation-has-operationid
Every operation declares an operationId (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
info
operationid-casing-snake
operationIds are snakeCase (measured: 86% of this contract)
$.paths[*][get,post,put,patch,delete].operationId
error
operation-has-summary
Every operation has a summary (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
info
operation-has-description
Every operation has a description (measured: 89% of this contract)
$.paths[*][get,post,put,patch,delete]
warn
operation-has-tags
Every operation is tagged (measured: 97% 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
info
path-segment-casing-camel
Path segments are camel case (measured: 86% of this contract)
$.paths[*]~
warn
path-no-trailing-slash
Paths carry no trailing slash (measured: 98% of this contract)
$.paths[*]~
error
path-params-in-braces
Path parameters use {braces}, not :colon (measured: 100% of this contract)
$.paths[*]~
error
schema-has-description
Every component schema carries a title or description (measured: 100% of this contract)
$.components.schemas[*]
Spectral Ruleset
Work with this as data
Every ruleset here is available over the APIs.io API and to AI agents over MCP.