Rules

Every OpenLint rule we know of, each with its own page: the 134 rules in the built-in rulesets, plus examples from the specification and learn.

138 rules

arazzo-document-schema spectral:arazzo error
Arazzo Document must be valid against the Arazzo schema.
arazzo-info-description spectral:arazzo warn
Info "description" should be present and non-empty string.
arazzo-info-summary spectral:arazzo hint
Info "summary" is recommended be present and be a non-empty string.
arazzo-no-script-tags-in-markdown spectral:arazzo warn
Markdown descriptions must not have "<script>" tags.
arazzo-source-descriptions-type spectral:arazzo warn
Source Description "type" should be present.
arazzo-step-description spectral:arazzo warn
Step "description" should be present and non-empty string.
arazzo-step-failure-actions-validation spectral:arazzo error
Every failure action must have a unique "name", and the fields "workflowId" and "stepId" are mutually exclusive.
arazzo-step-operationPath spectral:arazzo hint
It is recommended to use "operationId" rather than "operationPath".
arazzo-step-output-validation spectral:arazzo error
Every step output must have unique name and its value must be a valid runtime expression.
arazzo-step-parameters-validation spectral:arazzo error
Step parameters and workflow parameters must valid.
arazzo-step-request-body-validation spectral:arazzo error
Every step request body must have a valid `contentType` and use of runtime expressions.
arazzo-step-stepId spectral:arazzo warn
Step "stepId" should follow the pattern "^[A-Za-z0-9_\-]+$".
arazzo-step-success-actions-validation spectral:arazzo error
Every success action must have a unique "name", and the fields "workflowId" and "stepId" are mutually exclusive.
arazzo-step-success-criteria-validation spectral:arazzo error
Every success criteria must have a valid context, conditions, and types.
arazzo-step-validation spectral:arazzo error
Every step must have a valid "stepId" and an valid "operationId" or "operationPath" or "workflowId".
arazzo-workflow-depends-on-validation spectral:arazzo error
Every workflow dependency must be valid.
arazzo-workflow-description spectral:arazzo warn
Workflow "description" should be present and non-empty string.
arazzo-workflow-output-validation spectral:arazzo error
Every workflow output must have unique name and its value must be a valid runtime expression.
arazzo-workflow-stepId-unique spectral:arazzo error
Every step must have unique "stepId".
arazzo-workflow-summary spectral:arazzo hint
Workflow "summary" should be present and non-empty string.
arazzo-workflow-workflowId spectral:arazzo warn
Workflow "workflowId" should follow the pattern "^[A-Za-z0-9_\-]+$".
arazzo-workflowId-unique spectral:arazzo error
Every workflow must have unique "workflowId".
array-items spectral:oas error
asyncapi-3-channel-no-empty-parameter spectral:asyncapi warn
Channel address must not have empty parameter substitution pattern.
asyncapi-3-channel-no-query-nor-fragment spectral:asyncapi warn
Channel address must not include query ("?") or fragment ("#") delimiter.
asyncapi-3-channel-no-trailing-slash spectral:asyncapi warn
Channel address must not end with slash.
asyncapi-3-channel-servers spectral:asyncapi error
Channel servers must be defined in the "servers" object.
asyncapi-3-document-resolved spectral:asyncapi error
Checking if the AsyncAPI v3 document has valid structure after resolving references.
asyncapi-3-document-unresolved spectral:asyncapi error
Checking if the AsyncAPI v3 document has valid structure before resolving references.
asyncapi-3-headers-schema-type-object spectral:asyncapi error
Headers schema type must be "object".
asyncapi-3-operation-description spectral:asyncapi warn
Operation "description" must be present and non-empty string.
asyncapi-3-operation-security spectral:asyncapi error
Operation have to reference a defined security schemes.
asyncapi-3-payload-unsupported-schemaFormat spectral:asyncapi info
Message schema validation is only supported with default unspecified "schemaFormat".
asyncapi-3-server-no-empty-variable spectral:asyncapi warn
Server host and pathname must not have empty variable substitution pattern.
asyncapi-3-server-no-trailing-slash spectral:asyncapi warn
Server host must not end with slash.
asyncapi-3-server-not-example-com spectral:asyncapi warn off by default
Server host must not point at example.com.
asyncapi-3-tag-description spectral:asyncapi warn off by default
Tag object must have "description".
asyncapi-3-tags spectral:asyncapi warn
AsyncAPI document must have non-empty "tags" array.
asyncapi-3-tags-alphabetical spectral:asyncapi warn off by default
AsyncAPI object must have alphabetical "tags".
asyncapi-3-tags-uniqueness spectral:asyncapi error
Each tag must have a unique name.
asyncapi-channel-no-empty-parameter spectral:asyncapi warn
Channel path must not have empty parameter substitution pattern.
asyncapi-channel-no-query-nor-fragment spectral:asyncapi warn
Channel path must not include query ("?") or fragment ("#") delimiter.
asyncapi-channel-no-trailing-slash spectral:asyncapi warn
Channel path must not end with slash.
asyncapi-channel-parameters spectral:asyncapi error
Channel parameters must be defined and there must be no redundant parameters.
asyncapi-channel-servers spectral:asyncapi error
Channel servers must be defined in the "servers" object.
asyncapi-headers-schema-type-object spectral:asyncapi error
Headers schema type must be "object".
asyncapi-info-contact spectral:asyncapi warn
Info object must have "contact" object.
asyncapi-info-contact-properties spectral:asyncapi warn
Contact object must have "name", "url" and "email".
asyncapi-info-description spectral:asyncapi warn
Info "description" must be present and non-empty string.
asyncapi-info-license spectral:asyncapi warn
Info object must have "license" object.
asyncapi-info-license-url spectral:asyncapi warn off by default
License object must include "url".
asyncapi-latest-version spectral:asyncapi info
Checking if the AsyncAPI document is using the latest version.
asyncapi-message-examples spectral:asyncapi error
Examples of message object should follow by "payload" and "headers" schemas.
asyncapi-message-messageId-uniqueness spectral:asyncapi error
"messageId" must be unique across all the messages.
asyncapi-operation-description spectral:asyncapi warn
Operation "description" must be present and non-empty string.
asyncapi-operation-operationId spectral:asyncapi error
Operation must have "operationId".
asyncapi-operation-operationId-uniqueness spectral:asyncapi error
"operationId" must be unique across all the operations.
asyncapi-operation-security spectral:asyncapi error
Operation have to reference a defined security schemes.
asyncapi-parameter-description spectral:asyncapi warn off by default
Parameter objects must have "description".
asyncapi-payload spectral:asyncapi error
Payloads must be valid against AsyncAPI Schema object.
asyncapi-payload-default spectral:asyncapi error
Default must be valid against its defined schema.
asyncapi-payload-examples spectral:asyncapi error
Examples must be valid against their defined schema.
asyncapi-payload-unsupported-schemaFormat spectral:asyncapi info
Message schema validation is only supported with default unspecified "schemaFormat".
asyncapi-schema spectral:asyncapi error
Validate structure of AsyncAPI specification.
asyncapi-schema-default spectral:asyncapi error
Default must be valid against its defined schema.
asyncapi-schema-examples spectral:asyncapi error
Examples must be valid against their defined schema.
asyncapi-server-no-empty-variable spectral:asyncapi warn
Server URL must not have empty variable substitution pattern.
asyncapi-server-no-trailing-slash spectral:asyncapi warn
Server URL must not end with slash.
asyncapi-server-not-example-com spectral:asyncapi warn off by default
Server URL must not point at example.com.
asyncapi-server-security spectral:asyncapi error
Server have to reference a defined security schemes.
asyncapi-server-variables spectral:asyncapi error
Server variables must be defined and there must be no redundant variables.
asyncapi-servers spectral:asyncapi warn
AsyncAPI object must have non-empty "servers" object.
asyncapi-tag-description spectral:asyncapi warn off by default
Tag object must have "description".
asyncapi-tags spectral:asyncapi warn
AsyncAPI object must have non-empty "tags" array.
asyncapi-tags-alphabetical spectral:asyncapi warn off by default
AsyncAPI object must have alphabetical "tags".
asyncapi-tags-uniqueness spectral:asyncapi error
Each tag must have a unique name.
asyncapi-unused-components-schema spectral:asyncapi warn
Potentially unused components schema has been detected.
asyncapi-unused-components-server spectral:asyncapi warn
Potentially unused components server has been detected.
contact-properties spectral:oas warn off by default
Contact object must have "name", "url" and "email".
duplicated-entry-in-enum spectral:oas warn
Enum values must not have duplicate entry.
info-contact spectral:oas warn
Info object must have "contact" object.
info-description spectral:oas warn
Info "description" must be present and non-empty string.
info-license spectral:oas warn off by default
Info object must have "license" object.
license-url spectral:oas warn off by default
License object must include "url".
no-$ref-siblings spectral:oas error
Property must not be placed among $ref
no-eval-in-markdown spectral:oas warn
Markdown descriptions must not have "eval(".
no-script-tags-in-markdown spectral:oas warn
Markdown descriptions must not have "<script>" tags.
oas2-anyOf spectral:oas warn
anyOf is not available in OpenAPI v2, it was added in OpenAPI v3
oas2-api-host spectral:oas warn
OpenAPI "host" must be present and non-empty string.
oas2-api-schemes spectral:oas warn
OpenAPI host "schemes" must be present and non-empty array.
oas2-discriminator spectral:oas error
discriminator property must be defined and required
oas2-host-not-example spectral:oas warn off by default
Host URL must not point at example.com.
oas2-host-trailing-slash spectral:oas warn
Server URL must not have trailing slash.
oas2-oneOf spectral:oas warn
oneOf is not available in OpenAPI v2, it was added in OpenAPI v3
oas2-operation-formData-consume-check spectral:oas warn
Operations with "in: formData" parameter must include "application/x-www-form-urlencoded" or "multipart/form-data" in their "consumes" property.
oas2-operation-security-defined spectral:oas warn
Operation "security" values must match a scheme defined in the "securityDefinitions" object.
oas2-parameter-description spectral:oas warn off by default
Parameter objects must have "description".
oas2-schema spectral:oas error
Validate structure of OpenAPI v2 specification.
oas2-unused-definition spectral:oas warn
Potentially unused definition has been detected.
oas2-valid-media-example spectral:oas error
Examples must be valid against their defined schema.
oas2-valid-schema-example spectral:oas error
Examples must be valid against their defined schema.
oas3-api-servers spectral:oas warn
OpenAPI "servers" must be present and non-empty array.
oas3-callbacks-in-callbacks spectral:oas warn
oas3-examples-value-or-externalValue spectral:oas warn
Examples must have either "value" or "externalValue" field.
oas3-operation-security-defined spectral:oas warn
Operation "security" values must match a scheme defined in the "components.securitySchemes" object.
oas3-parameter-description spectral:oas warn off by default
Parameter objects must have "description".
oas3-schema spectral:oas error
Validate structure of OpenAPI v3 specification.
oas3-server-not-example.com spectral:oas warn off by default
Server URL must not point at example.com.
oas3-server-trailing-slash spectral:oas warn
Server URL must not have trailing slash.
oas3-server-variables spectral:oas error
Server variables must be defined and valid and there must be no unused variables.
oas3-unused-component spectral:oas warn
oas3-valid-media-example spectral:oas error
Examples must be valid against their defined schema.
oas3-valid-schema-example spectral:oas error
Examples must be valid against their defined schema.
oas3_1-callbacks-in-webhook spectral:oas warn
oas3_1-servers-in-webhook spectral:oas warn
oas3_2-no-deprecated-xml-attribute spectral:oas warn
openapi-tags spectral:oas warn off by default
OpenAPI object must have non-empty "tags" array.
openapi-tags-alphabetical spectral:oas warn off by default
OpenAPI object must have alphabetical "tags".
openapi-tags-uniqueness spectral:oas error
Each tag must have a unique name.
operation-description spectral:oas warn
Operation "description" must be present and non-empty string.
operation-has-tags OpenLint Ruleset Specification hint
Every operation is tagged.
operation-id-camel-case OpenLint Ruleset Specification warn off by default
operationId is written in camelCase.
operation-operationId spectral:oas warn
Operation must have "operationId".
operation-operationId-unique spectral:oas error
Every operation must have unique "operationId".
operation-operationId-valid-in-url spectral:oas warn
operation-parameters spectral:oas warn
Operation parameters are unique and non-repeating.
operation-singular-tag spectral:oas warn off by default
Operation must not have more than a single tag.
operation-success-response spectral:oas warn
Operation must have at least one "2xx" or "3xx" response.
operation-summary OpenLint Ruleset Specification warn
Every operation needs a summary.
operation-tag-defined spectral:oas warn
Operation tags must be defined in global tags.
operation-tags spectral:oas warn
Operation must have non-empty "tags" array.
path-declarations-must-exist spectral:oas warn
path-keys-no-trailing-slash spectral:oas warn
path-not-include-query spectral:oas warn
Path must not include query string.
path-params spectral:oas error
Path parameters must be defined and valid.
server-https OpenLint Learn warn
Every server URL uses https.
tag-description spectral:oas warn off by default
Tag object must have "description".
typed-enum spectral:oas warn
Enum values must respect the specified type.

The same list as data: rules.json. Rules are generated from @openlint/openlint-rulesets, the toolbox's reference docs and the specification; see openlint/rules to add one.