Skip to content

Commit 875ab1e

Browse files
committed
"format" is an annotation
1 parent 17f5a46 commit 875ab1e

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

versions/3.1.0.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,8 @@ However, to support documentation needs, the `format` property is an open `strin
153153
Additional formats MAY be used even though undefined by either JSON Schema or this specification.
154154
Types that are not accompanied by a `format` property follow the type definition in the JSON Schema. Tools that do not recognize a specific `format` MAY default back to the `type` alone, as if the `format` is not specified.
155155

156+
Note that by default, JSON Schema validators MUST NOT attempt to validate the `format` keyword. It is primarily treated as an annotation that informs applications of the intended nature of the data. For historical reasons, it is possible to configure JSON Schema validators to validate "format", but this is not consistently implemented and SHOULD NOT be relied upon in any environment where an unknown validator or unknown validator configuration might be used.
157+
156158
The formats defined by the OAS are:
157159

158160
[`type`](#dataTypes) | [`format`](#dataTypeFormat) | Comments

0 commit comments

Comments
 (0)