Recommended ruleset
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-server-trailing-slash
- no-server-variables-empty-enum
- no-undefined-server-variable
- no-unresolved-refs
- operation-operationId-unique
- operation-operationId-url-safe
- operation-parameters-unique
- operation-summary
- path-declaration-must-exist
- path-not-include-query
- path-parameters-defined
- security-defined
- spec-components-invalid-map-name
- spec
Warnings:
- configurable rules
- info-license-url
- info-license
- no-ambiguous-paths
- no-invalid-media-type-examples
- no-server-example.com
- no-unused-components
- operation-2xx-response
- operation-4xx-response
- operation-operationId
- tag-description
Recommended strict ruleset
There is also a recommended-strict
version of recommended
, which elevates all warnings to errors.