Valjean Specialty · API Governance Rules
Valjean Specialty API Rules
Spectral linting rules defining API design standards and conventions for Valjean Specialty.
81 Rules
error 71
warn 6
info 4
Generated by API Evangelist
Written by API Evangelist tooling for Valjean Specialty's APIs. It is a starting point, not a ruleset Valjean Specialty publishes or enforces.
Rule Categories
contact
header
info
license
mediatype
oauthflow
operation
operationid
parameter
path
property
requestbody
response
root
schema
securityscheme
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
info
operation-declares-401-or-403
Every operation declares 401 or 403 (measured: 87% of this contract)
$.paths[*][get,post,put,patch,delete].responses
error
operation-declares-429
Every operation declares 429 (rate limited) (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete].responses
info
operation-secured
Every operation declares its own security requirement (measured: 87% of this contract)
$.paths[*][get,post,put,patch,delete]
error
root-security-declared
The contract declares security at the root (measured: 100% of this contract)
$
error
path-segment-casing-kebab
Path segments are kebab 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
warn
write-declares-request-body
POST and PUT declare a request body (measured: 92% 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
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
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-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
contact-email-present
Contact declares email (measured: 100% of this contract)
$.info.contact
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
server-description-present
Server declares description (measured: 100% of this contract)
$.servers[*]
error
tag-name-present
Tag declares name (measured: 100% of this contract)
$.tags[*]
warn
tag-name-casing-pascal
Tag.name is pascal case (measured: 92% of this contract)
$.tags[*].name
error
tag-description-present
Tag declares description (measured: 100% of this contract)
$.tags[*]
error
tag-description-min-length
Tag.description runs at least 27 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 13 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 79 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
operation-security-present
Operation declares security (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[*]
info
parameter-name-casing-snake
Parameter.name is snake case (measured: 89% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].name
error
parameter-in-present
Parameter declares in (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
warn
parameter-in-values
Parameter.in is one of path, query (measured: 95% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].in
warn
parameter-description-min-length
Parameter.description runs at least 11 characters (measured: 96% 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-style-values
Parameter.style is one of form (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].style
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
info
response-headers-present
Response declares headers (measured: 88% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*]
warn
response-content-present
Response declares content (measured: 97% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*]
error
header-schema-present
Header declares schema (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].headers[*]
error
schema-type-values
Schema.type is one of object (measured: 100% of this contract)
$.components.schemas[*].type
error
schema-description-min-length
Schema.description runs at least 33 characters (measured: 100% of this contract)
$.components.schemas[*].description
error
securityscheme-type-present
SecurityScheme declares type (measured: 100% of this contract)
$.components.securitySchemes[*]
error
securityscheme-type-values
SecurityScheme.type is one of apiKey, http, oauth2 (measured: 100% of this contract)
$.components.securitySchemes[*].type
error
securityscheme-description-present
SecurityScheme declares description (measured: 100% of this contract)
$.components.securitySchemes[*]
error
securityscheme-in-values
SecurityScheme.in is one of header (measured: 100% of this contract)
$.components.securitySchemes[*].in
error
securityscheme-scheme-values
SecurityScheme.scheme is one of bearer (measured: 100% of this contract)
$.components.securitySchemes[*].scheme
error
securityscheme-bearerformat-values
SecurityScheme.bearerFormat is one of vjk_live_… / vjk_demo_… API key, or an OAuth access token (vjat_…) (measured: 100% of this contract)
$.components.securitySchemes[*].bearerFormat
error
oauthflow-authorizationurl-present
OAuthFlow declares authorizationUrl (measured: 100% of this contract)
$.components.securitySchemes[*].flows[*]
error
oauthflow-authorizationurl-https
OAuthFlow.authorizationUrl is https (measured: 100% of this contract)
$.components.securitySchemes[*].flows[*].authorizationUrl
error
oauthflow-tokenurl-present
OAuthFlow declares tokenUrl (measured: 100% of this contract)
$.components.securitySchemes[*].flows[*]
error
oauthflow-tokenurl-https
OAuthFlow.tokenUrl is https (measured: 100% of this contract)
$.components.securitySchemes[*].flows[*].tokenUrl
error
oauthflow-refreshurl-present
OAuthFlow declares refreshUrl (measured: 100% of this contract)
$.components.securitySchemes[*].flows[*]
error
oauthflow-refreshurl-https
OAuthFlow.refreshUrl is https (measured: 100% of this contract)
$.components.securitySchemes[*].flows[*].refreshUrl
error
oauthflow-scopes-present
OAuthFlow declares scopes (measured: 100% of this contract)
$.components.securitySchemes[*].flows[*]
Spectral Ruleset
Work with this as data
Every ruleset here is available over the APIs.io API and to AI agents over MCP.