CrowdWisdom Signals API · API Governance Rules
CrowdWisdom Signals API API Rules
Spectral linting rules defining API design standards and conventions for CrowdWisdom Signals API.
10 Rules
error 8
warn 1
info 1
Rule Categories
info
operation
path
property
response
schema
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-success-response
Every operation declares a 2xx response (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete].responses
warn
path-segment-casing-camel
Path segments are camel case (measured: 95% 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[*]~
info
response-media-type
Responses are served as application/json (measured: 89% of this contract)
$.paths[*][get,post,put,patch,delete].responses[*].content
error
schema-has-description
Every component schema carries a title or description (measured: 100% of this contract)
$.components.schemas[*]
error
property-name-casing-camel
Schema property names are camel case (measured: 100% 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.