Coalesceautomation · API Governance Rules
Coalesceautomation API Rules
Spectral linting rules defining API design standards and conventions for Coalesceautomation.
12 Rules
error 10
warn 1
info 1
Generated by API Evangelist
Written by API Evangelist tooling for Coalesceautomation's APIs. It is a starting point, not a ruleset Coalesceautomation publishes or enforces.
Rule Categories
info
operation
operationid
path
property
servers
Rules
error
operation-has-operationid
Every operation declares an operationId (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
warn
operationid-casing-snake
operationIds are snakeCase (measured: 91% 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]
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
error
operation-secured
Every operation is covered by a security requirement (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
error
path-segment-casing-camel
Path segments are camel case (measured: 100% of this contract)
$.paths[*]~
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
property-name-casing-flat
Schema property names are flat case (measured: 82% of this contract)
$.components.schemas[*].properties[*]~
error
info-has-description
The contract's info block carries a description (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.