LianLian Global · API Governance Rules
LianLian Global API Rules
Spectral linting rules defining API design standards and conventions for LianLian Global.
43 Rules
error 23
warn 15
info 5
Generated by API Evangelist
Written by API Evangelist tooling for LianLian Global's APIs. It is a starting point, not a ruleset LianLian Global publishes or enforces.
Rule Categories
contact
header
info
mediatype
oauthflow
operation
parameter
path
requestbody
response
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
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
warn
path-segment-casing-kebab
Path segments are kebab case (measured: 92% of this contract)
$.paths[*]~
warn
path-no-trailing-slash
Paths carry no trailing slash (measured: 99% of this contract)
$.paths[*]~
error
path-params-in-braces
Path parameters use {braces}, not :colon (measured: 100% of this contract)
$.paths[*]~
info
servers-https
Servers are https (measured: 84% of this contract)
$.servers[*].url
warn
write-declares-request-body
POST and PUT declare a request body (measured: 98% of this contract)
$.paths[*][post,put]
warn
response-media-type
Responses are served as application/json (measured: 98% of this contract)
$.paths[*][get,post,put,patch,delete].responses[*].content
warn
schema-has-description
Every component schema carries a title or description (measured: 98% of this contract)
$.components.schemas[*]
error
info-title-present
Info declares title (measured: 100% of this contract)
$.info
warn
info-title-min-length
Info.title runs at least 9 characters (measured: 97% of this contract)
$.info.title
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-email-present
Contact declares email (measured: 100% of this contract)
$.info.contact
error
server-url-present
Server declares url (measured: 100% of this contract)
$.servers[*]
info
server-url-https
Server.url is https (measured: 84% of this contract)
$.servers[*].url
error
tag-name-present
Tag declares name (measured: 100% of this contract)
$.tags[*]
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]
warn
operation-summary-min-length
Operation.summary runs at least 4 characters (measured: 98% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].summary
error
operation-operationid-present
Operation declares operationId (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-responses-present
Operation declares responses (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
warn
parameter-in-values
Parameter.in is one of header, query (measured: 98% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].in
warn
parameter-description-min-length
Parameter.description runs at least 2 characters (measured: 99% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].description
error
requestbody-content-present
RequestBody declares content (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].requestBody
warn
mediatype-schema-present
MediaType declares schema (measured: 99% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].content[*]
warn
response-description-present
Response declares description (measured: 99% 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[*]
warn
schema-title-present
Schema declares title (measured: 99% of this contract)
$.components.schemas[*]
warn
schema-type-present
Schema declares type (measured: 99% of this contract)
$.components.schemas[*]
warn
schema-type-values
Schema.type is one of object, string (measured: 96% of this contract)
$.components.schemas[*].type
info
schema-properties-present
Schema declares properties (measured: 88% of this contract)
$.components.schemas[*]
error
securityscheme-type-present
SecurityScheme declares type (measured: 100% of this contract)
$.components.securitySchemes[*]
warn
securityscheme-type-values
SecurityScheme.type is one of apiKey, oauth2 (measured: 97% of this contract)
$.components.securitySchemes[*].type
info
securityscheme-description-present
SecurityScheme declares description (measured: 83% 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 basic (measured: 100% of this contract)
$.components.securitySchemes[*].scheme
info
securityscheme-flows-present
SecurityScheme declares flows (measured: 83% of this contract)
$.components.securitySchemes[*]
error
oauthflow-tokenurl-present
OAuthFlow declares tokenUrl (measured: 100% of this contract)
$.components.securitySchemes[*].flows[*]
error
oauthflow-refreshurl-present
OAuthFlow declares refreshUrl (measured: 100% of this contract)
$.components.securitySchemes[*].flows[*]
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.