Cuvo Health · API Governance Rules
Cuvo Health API Rules
Spectral linting rules defining API design standards and conventions for Cuvo Health.
61 Rules
error 56
warn 4
info 1
Generated by API Evangelist
Written by API Evangelist tooling for Cuvo Health's APIs. It is a starting point, not a ruleset Cuvo Health publishes or enforces.
Rule Categories
contact
info
license
mediatype
operation
operationid
parameter
path
property
requestbody
response
schema
server
servers
tag
write
Rules
error
operation-has-operationid
Every operation declares an operationId (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
error
operationid-casing-camel
operationIds are camel case (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-description
Every operation has a description (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-declares-4xx
Every operation declares at least one 4xx response (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete].responses
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
write-declares-request-body
POST and PUT declare a request body (measured: 87% of this contract)
$.paths[*][post,put]
error
schema-has-description
Every component schema carries a title or description (measured: 100% of this contract)
$.components.schemas[*]
warn
property-name-casing-snake
Schema property names are snake case (measured: 95% of this contract)
$.components.schemas[*].properties[*]~
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
error
info-title-present
Info declares title (measured: 100% of this contract)
$.info
error
info-summary-present
Info declares summary (measured: 100% of this contract)
$.info
error
info-description-present
Info declares description (measured: 100% of this contract)
$.info
error
info-termsofservice-present
Info declares termsOfService (measured: 100% of this contract)
$.info
error
info-termsofservice-https
Info.termsOfService is https (measured: 100% of this contract)
$.info.termsOfService
error
info-contact-present
Info declares contact (measured: 100% of this contract)
$.info
error
info-license-present
Info declares license (measured: 100% of this contract)
$.info
error
info-version-present
Info declares version (measured: 100% of this contract)
$.info
error
info-version-semver
info.version is numeric (measured: 100% of this contract)
$.info.version
error
contact-name-present
Contact declares name (measured: 100% of this contract)
$.info.contact
error
contact-url-present
Contact declares url (measured: 100% of this contract)
$.info.contact
error
contact-url-https
Contact.url is https (measured: 100% of this contract)
$.info.contact.url
error
license-name-present
License declares name (measured: 100% of this contract)
$.info.license
error
license-url-present
License declares url (measured: 100% of this contract)
$.info.license
error
license-url-https
License.url is https (measured: 100% of this contract)
$.info.license.url
error
server-url-present
Server declares url (measured: 100% of this contract)
$.servers[*]
error
server-url-https
Server.url is https (measured: 100% of this contract)
$.servers[*].url
error
tag-name-present
Tag declares name (measured: 100% of this contract)
$.tags[*]
error
tag-description-present
Tag declares description (measured: 100% of this contract)
$.tags[*]
error
tag-description-min-length
Tag.description runs at least 17 characters (measured: 100% of this contract)
$.tags[*].description
error
operation-tags-present
Operation declares tags (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-summary-present
Operation declares summary (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-summary-min-length
Operation.summary runs at least 14 characters (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].summary
error
operation-description-present
Operation declares description (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
warn
operation-description-min-length
Operation.description runs at least 86 characters (measured: 96% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].description
error
operation-operationid-present
Operation declares operationId (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-operationid-casing-camel
Operation.operationId is camel case (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].operationId
error
operation-responses-present
Operation declares responses (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
parameter-name-present
Parameter declares name (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
parameter-in-present
Parameter declares in (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
parameter-description-present
Parameter declares description (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
parameter-description-min-length
Parameter.description runs at least 21 characters (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].description
error
parameter-required-present
Parameter declares required (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
parameter-schema-present
Parameter declares schema (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
requestbody-content-present
RequestBody declares content (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].requestBody
error
requestbody-required-present
RequestBody declares required (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].requestBody
error
mediatype-schema-present
MediaType declares schema (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].content[*]
error
response-description-present
Response declares description (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*]
error
response-description-min-length
Response.description runs at least 2 characters (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].description
warn
response-content-present
Response declares content (measured: 94% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*]
error
schema-type-present
Schema declares type (measured: 100% of this contract)
$.components.schemas[*]
error
schema-type-values
Schema.type is one of object (measured: 100% of this contract)
$.components.schemas[*].type
error
schema-description-present
Schema declares description (measured: 100% of this contract)
$.components.schemas[*]
warn
schema-description-min-length
Schema.description runs at least 39 characters (measured: 95% of this contract)
$.components.schemas[*].description
error
schema-required-present
Schema declares required (measured: 100% of this contract)
$.components.schemas[*]
error
schema-properties-present
Schema declares properties (measured: 100% of this contract)
$.components.schemas[*]
Spectral Ruleset
Work with this as data
Every ruleset here is available over the APIs.io API and to AI agents over MCP.