OAS-Kit Default Linter Rules

Name OpenAPI Object Description
parameter-description parameter parameter objects should have a description
operation-operationId operation operation should have an operationId
operation-summary-or-description operation operation should have summary or description
operation-tags operation operation should have non-empty tags array
server-trailing-slash server server url should not have a trailing slash
path-keys-no-trailing-slash paths paths should not end with a slash
openapi-tags openapi openapi object should have non-empty tags array
openapi-tags-alphabetical openapi openapi object should have alphabetical tags
reference-no-other-properties reference reference objects should only have a $ref property
example-value-or-externalValue example example should have either value or externalValue
no-script-tags-in-markdown everything markdown descriptions should not contain script tags
info-contact info info object should contain contact object
license-apimatic-bug license license url should not point at gruntjs
no-eval-in-descriptions everything markdown descriptions should not contain 'eval('
contact-properties contact contact object should have name, url and email
license-url license license object should include url
server-not-example.com server server url should not point at example.com
tag-description tag tag object should have a description
operations-must-exist metadata.count One or more operation objects must be present
document-max-length metadata Document should have a max length of 1000 lines