Skip to content

Commit

Permalink
Fix tiny typo in format.markdown (#256)
Browse files Browse the repository at this point in the history
  • Loading branch information
JonathanPicques authored Jun 20, 2024
1 parent 54950cf commit d0f906c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion content/2020-12/format-annotation/format.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The `format` keyword in JSON Schema's Format Annotation vocabulary serves to pro

When using `format` from Format Annotation, it's recommended that you provide your validation rules alongside the `format`. The implementation may choose to treat `format` as an assertion and attempt to validate the value's conformance to the specified semantics. However, this behavior must be explicitly enabled and is typically disabled by default. Implementations should document their level of support for such validation.

* `It allows for the semantic identification of certain kinds of string values. For instance, it can indicate that a string value should be interpreted as a date, email, URI, etc.
* It allows for the semantic identification of certain kinds of string values. For instance, it can indicate that a string value should be interpreted as a date, email, URI, etc.
* `format` is solely an annotation and does not enforce any validation. It's meant to provide information about the expected format of the string.
* Implementations may choose to enable format as an assertion, meaning that validation fails if the value doesn't conform to the specified format semantics. However, this is not mandatory and must be explicitly enabled.
* While users can define and use their own custom `formats` (e.g., "format": "foobar"), it's recommended to refrain from overloading the format keyword for future compatibility reasons. Instead, define custom keywords for specific validation requirements. For example in the event that you define your own "foobar" and JSON Schema subsequently chooses to define "foobar," you may encounter difficulties.
Expand Down

0 comments on commit d0f906c

Please sign in to comment.