ServGhost Agent API · API Governance Rules
ServGhost Agent API API Rules
Spectral linting rules defining API design standards and conventions for ServGhost Agent API.
9 Rules
error 7
warn 1
info 1
Rule Categories
info
operation
path
servers
write
Rules
error
operation-has-summary
Every operation has a summary (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
error
path-segment-casing-camel
Path segments are camel case (measured: 100% of this contract)
$.paths[*]~
warn
path-no-trailing-slash
Paths carry no trailing slash (measured: 92% 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: 80% of this contract)
$.paths[*][post,put]
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.