Linter rulesAsyncAPIschema-format-unknown
schema-format-unknown
Since 0.10.0
This rule reports a format of a AsyncAPI document which is neither in the
OpenAPI format registry nor
declared in openapi.custom_formats of the
configuration file.
Rule Details
Tools ignore formats they don’t know, so a misspelled format (date_time,
uuid4) silently stops being checked. Formats defined on purpose are declared
in the configuration file:
openapi:
custom_formats:
- {name: currency-code, type: string}The rule is off in the recommended ruleset and a warning in strict and
all. See Formats for the registry’s
formats.
Configuration
None.
When Not to Use It
When the documents use many formats of their own and listing them in the configuration file isn’t worth it.