| slug |
|---|
/docs/cli/rules/recommended |
These are the rules in the recommended set, grouped by their severity.
Errors:
- no-empty-servers
- no-enum-type-mismatch
- no-example-value-and-externalValue
- no-identical-paths
- no-path-trailing-slash
- no-schema-type-mismatch
- no-server-trailing-slash
- no-server-variables-empty-enum
- no-undefined-server-variable
- no-unresolved-refs
- nullable-type-sibling
- operation-operationId-unique
- operation-operationId-url-safe
- operation-parameters-unique
- operation-summary
- parameters-unique
- path-declaration-must-exist
- path-not-include-query
- path-parameters-defined
- security-defined
- sourceDescription-name-unique
- sourceDescription-type
- sourceDescriptions-not-empty
- spec-components-invalid-map-name
- spec-example-values
- spec-no-invalid-encoding-combinations
- spec-no-invalid-tag-parents
- stepId-unique
- struct
- workflow-dependsOn
- workflowId-unique
Warnings:
- configurable rules
- criteria-unique
- info-license
- info-license-strict
- no-ambiguous-paths
- no-duplicated-tag-names
- no-invalid-media-type-examples
- no-invalid-parameter-examples
- no-invalid-schema-examples
- no-required-schema-properties-undefined
- no-server-example.com
- no-unused-components
- operation-2xx-response
- operation-4xx-response
- operation-operationId
- requestBody-replacements-unique
- spec-discriminator-defaultMapping
- step-onFailure-unique
- step-onSuccess-unique
- tag-description
There is also a recommended-strict version of recommended, which elevates all warnings to errors.
A copy-pastable version of this ruleset is available as a ruleset template.