Aspiresingapore · API Governance Rules
Aspiresingapore API Rules
Spectral linting rules defining API design standards and conventions for Aspiresingapore.
13 Rules
error 11
warn 1
info 1
Rule Categories
info
operation
operationid
path
property
servers
write
Rules
warn
operation-has-operationid
Every operation declares an operationId (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
error
operationid-casing-snake
operationIds are snakeCase (measured: 100% 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]
info
path-segment-casing-camel
Path segments are camel case (measured: 89% 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
error
write-declares-request-body
POST and PUT declare a request body (measured: 100% of this contract)
$.paths[*][post,put]
error
property-name-casing-snake
Schema property names are snake 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.