feature request: Hide AJVs "unknown format" complaints

[nulltoken]

Describe the bug

According to the spec, format is is an open string-valued property, and can have any value.
Spectral generates (pollutes?) stdout with warnings about "unknown format"s.

To Reproduce

repro/output.openapi.yaml

openapi: 3.0.0
servers:
  - url: "https://ex-ample.com"
x-format-version: "1.0"
info:
  title: Four
  description: Issue repro 4
  contact:
    email: e@e.com
  version: 0.0.0
paths: {}
components:
  schemas:
    AModel:
      description: Yet another self descriptive explanation
      type: object
      properties:
        a_country:
          description: Guess what? A country.
          type: string
          format: "ISO-3166-1 alpha-2"
          example: de

Run

$ yarn spectral lint repro/output.openapi.yaml -o repro/log.txt -q
yarn run v1.15.2
$ C:\REDACTED\node_modules\.bin\spectral lint repro/output2.openapi.yaml -o repro/log.txt -q
unknown format "ISO-3166-1 alpha-2" ignored in schema at path "#"
unknown format "ISO-3166-1 alpha-2" ignored in schema at path "#"
Done in 1.52s.

repro/log.txt

(empty)

Expected behavior
Nothing in stderr/stdout

Environment (remove any that are not applicable):

• Library version: 4.0.1
• OS: Windows 7

[philsturgeon]

Hey there, this related to ajv-validator/ajv#466 in which the author of AJV makes it very clear that people should be aware of unknown formats.

I would like to try and hide these specific messages because you are correct, the OAS spec does say you can use whatever you want.

[chris-miaskowski]

Hey folks, now reading through that issue @philsturgeon linked to and the maintainer has a valid point.

"ignore" - to log warning during schema compilation and always pass validation (the default behaviour in versions before 5.0.0). This option is not recommended, as it allows to mistype format name and it won’t be validated without any error message. This behaviour is required by JSON Schema specification.

I see three possible solutions:

• just mute all warnings and don't care about typos (should be possible with Configuration for console logging ajv-validator/ajv#618)
• add CLI param to turn the warnings on/off (it's up to the user whether they care about typos or not)
• try something smarter and detect typos

[philsturgeon]

If you'd like to try and find a way to convert these CLI outputs to spectral warnings then that's ok, but JSON Schema allows unknown formats so we should not shove all this stuff into the CLI when unknown formats are discovered. 🤷‍♂

A large part of the problem here, and something this issue is aiming to address, is that these are shoved into the console outside of normal spectral logic, so --quiet isnt helping get rid of them.

[chris-miaskowski]

If you'd like to try and find a way to convert these CLI outputs to spectral warnings then that's ok, but JSON Schema allows unknown formats so we should not shove all this stuff into the CLI when unknown formats are discovered. man_shrugging

Oh, interesting, that's a forth solution which I haven't thought about. Good idea. Ok, will play around with this stuff and see where I can take it.

[philsturgeon]

Maybe spike on it and see how far you get. The primary goal is to get the AJV format moaning out of the console, and maybe a follow up feature could be to have those format messages converted to spectral warnings or info :)

[chris-miaskowski]

yo, created a PR, please take a look if that's sufficient.

[chris-miaskowski]

and maybe a follow up feature could be to have those format messages converted to spectral warnings or info :)

Sounds good. Had a quick look and surfacing it at the spectral messages level will require some more work.