# schema-format-unknown

Source: https://apigenie.pl/docs/linter/openapi/rules/schema-format-unknown

A rule of the OpenAPI linter, which reads OpenAPI 3.0, 3.1 and 3.2 documents. Since 0.10.0. In the rulesets: Strict at warning, All at warning.

This rule reports a `format` which is neither in the
[OpenAPI format registry](https://spec.openapis.org/registry/format/) nor
declared in `openapi.custom_formats` of the configuration file.

## Rule details

Validators, mock servers and code generators ignore formats they do not know, so a misspelled
format (`date_time`, `uuid4`) stops being checked without a word. Formats your API defines on
purpose are declared in the
[configuration file](/docs/reference/cli/configuration#openapicustom_formats):

```yaml
openapi:
  custom_formats:
    - {name: currency-code, type: string}
```

The rule is off in the `recommended` ruleset, since OpenAPI allows any format, and a warning in
`strict` and `all`. See [Formats](/docs/reference/cli/formats) for the registry's formats. Turn
the rule off when the document uses many formats of its own and listing them in the configuration
file is not worth it.

## Examples

**Good**. `uuid` is in the registry.

```yaml
components:
  schemas:
    Id:
      type: string
      format: uuid
```

**Bad**. `uuid4` is not, so nothing checks the value.

```yaml
components:
  schemas:
    Id:
      type: string
      format: uuid4
```
