Tool should allow for custom formats to be used and not give an error if they are

Currently, if a format other than an OAS standard format is used anywhere in the swagger spec, this tool’s compare will throw an error of: Error: unknown format ”someCustomFormat” is used in schema at path ”somePropertyPath”.

Per the Swagger Documentation: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#Format

Under Data Types:
Primitives have an optional modifier property: format. OAS uses several known formats to define in fine detail the data type being used. However, to support documentation needs, the format property is an open string-valued property, and can have any value.

I believe the tool should be allowing these custom formats, and not throwing an error when they’re encountered in the specs. The following example should be valid:

{Swagger snippet}
  "definitions": {
    "someObject": {
       "properties": {
        "cost": {
          "type": "string"
          "format": "currency"
          "example": "$5.23"
        }
      }
    }
  }

‌

Comments (9)