Speakeasy Lint Configuration File

Configuration file for Speakeasy's OpenAPI document linting. Find out more at https://www.speakeasy.com/docs/linting

Type object
File match **/.speakeasy/lint.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/speakeasy-lint-configuration-file/latest.json
Source https://raw.githubusercontent.com/speakeasy-api/sdk-gen-config/main/schemas/lint.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

lintVersion string required
Constant: "1.0.0"
defaultRuleset string required
rulesets Record<string, object> required
customRules object
2 nested properties
paths string[]
timeout string

Definitions

ruleset object
rules Record<string, object>
rulesets string[]
rule object
given string
then then | then[]
severity string
Values: "error" "warn" "info" "hint" "off"
message string
description string
formats string[]
resolved boolean
Default: false
then object
field string
function string
functionOptions object
customRulesConfig object
paths string[]
timeout string