dataleads-pro · API Governance Rules
dataleads-pro API Rules
Spectral linting rules defining API design standards and conventions for dataleads-pro.
12 Rules
error 7
warn 4
info 1
Generated by API Evangelist
Written by API Evangelist tooling for dataleads-pro's APIs. It is a starting point, not a ruleset dataleads-pro publishes or enforces.
Rule Categories
operation
operationid
path
property
response
schema
write
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: 98% 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-success-response
Every operation declares a 2xx response (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete].responses
warn
operation-declares-4xx
Every operation declares at least one 4xx response (measured: 98% of this contract)
$.paths[*][get,post,put,patch,delete].responses
warn
path-segment-casing-camel
Path segments are camel case (measured: 99% 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[*]~
warn
write-declares-request-body
POST and PUT declare a request body (measured: 99% of this contract)
$.paths[*][post,put]
error
response-media-type
Responses are served as application/json (measured: 100% 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[*]
info
property-name-casing-camel
Schema property names are camel case (measured: 97% of this contract)
$.components.schemas[*].properties[*]~
Spectral Ruleset
Work with this as data
Every ruleset here is available over the APIs.io API and to AI agents over MCP.