JSON Schema to check date of YYYY-MM-DD

Question

Could someone tell me JSON Schema Validation for accepting date of YYYY-MM-DD format alone?

My sample JSON:

{"data1" : "foo", "date" :"2016-11-24"}

score 48 · Answer 1 · answered Feb 07 '18 at 13:10

48

JSON Schema already have defined format for date, time, datetime, email, hostname, IP address. You can prefer this easier and recommended method rather than writing your own regex.

"date": {
  "type": "string",
  "format": "date"
}

Date and time format names are derived from RFC 3339, section 5.6 [RFC3339].

Reference: http://json-schema.org/latest/json-schema-validation.html#rfc.section.7.3

answered Feb 07 '18 at 13:10

Ram Babu

2,692
3
23
28

2

As per the JSON specification, it seems that these formats are not mandatory. Is this correct? https://json-schema.org/understanding-json-schema/reference/string.html#format – nsx Nov 18 '20 at 23:16
1

@リカルド I think this note is unambiguous: *"JSON Schema implementations are not required to implement this part of the specification, and many of them do not."* – ceving Jul 23 '21 at 16:36
1

The documentation states that [format does not affect validation](https://json-schema.org/understanding-json-schema/reference/string.html#dates-and-times:~:text=By%20default%2C%20format%20is%20just%20an%20annotation%20and%20does%20not%20effect%20validation). – Troy Weber Jun 28 '22 at 21:18
It has based on the json schema validator you use. I mostly use `ajv` which considers the format field and will validate. You may need to check with the validator you using. @TroyWeber – Ram Babu Jul 02 '22 at 09:09
1

@RamBabu Thank you for clarifying. If you isn't too late to update your response to include that _some_ json-schema validators allow you to validate on this optional format, I recommend doing so since this is the highest voted answer, just for the sake of clarity. Otherwise, I'm glad to hear that `ajv` supports this behavior. – Troy Weber Jul 16 '22 at 01:15

Alekhya · Answer 2 · 2017-04-11T14:38:26.370

4

add regex to json schema in schema use the following.

{
   "type": "string",
   "pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
}

edited Apr 11 '17 at 14:38

answered Apr 11 '17 at 13:20

Alekhya

272
1
7

Using this regex will accept 30 February too.. thats my issue – user6543599 Apr 12 '17 at 06:10
oh ok you just pointed out for format.. but for validity you can refer to following link. http://stackoverflow.com/questions/51224/regular-expression-to-match-valid-dates/8768241#8768241 – Alekhya Apr 12 '17 at 12:43
Just tried this. Get an error: ValueError: Invalid \escape – GDB Aug 10 '17 at 22:12
1

double escape `\\d` – bwicklund Feb 06 '18 at 21:56
1

`\d` is not part of the [supported subset](http://json-schema.org/understanding-json-schema/reference/regular_expressions.html) of regex features. – barfuin Jun 18 '20 at 16:49
Correct Schema: `^(?:\d{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$` – Abinash May 10 '23 at 05:22

score 2 · Answer 3 · edited Oct 20 '21 at 05:30

2

Use built-in support for date validation:

{"type": "string", "format": "date"}

edited Oct 20 '21 at 05:30

vitaly

2,755
4
23
35

answered Oct 19 '21 at 13:34

medusasoftware

47
1

Your answer could be improved with additional supporting information. Please [edit] to add further details, such as citations or documentation, so that others can confirm that your answer is correct. You can find more information on how to write good answers [in the help center](/help/how-to-answer). – Community Oct 19 '21 at 13:48
1

Isn't it the same solution as [this answer](https://stackoverflow.com/a/48664720/2227743)? – Eric Aya Oct 19 '21 at 14:13
1

Please note that the documentation also states [that the "format" is more of an annotation](https://json-schema.org/understanding-json-schema/reference/string.html#dates-and-times:~:text=By%20default%2C%20format%20is%20just%20an%20annotation%20and%20does%20not%20effect%20validation) and doesn't trigger any validation without 3rd party libraries. – Troy Weber Jun 28 '22 at 21:13

score 1 · Answer 4 · answered Oct 06 '20 at 08:41

Use below solution ... it should work good for all dates in YYYY-MM-DD or YYYY/MM/DD format. It validated leap year and restricts dates in month of Feb as well.

{
   "type": "string",
   "pattern": "(((19|20)([2468][048]|[13579][26]|0[48])|2000)[/-]02[/-]29|((19|20)[0-9]{2}[/-](0[469]|11)[/-](0[1-9]|[12][0-9]|30)|(19|20)[0-9]{2}[/-](0[13578]|1[02])[/-](0[1-9]|[12][0-9]|3[01])|(19|20)[0-9]{2}[/-]02[/-](0[1-9]|1[0-9]|2[0-8])))"
}

ceving · Answer 5 · 2021-07-23T16:57:42.690

It is probably easier to use seconds since EPOCH or the Julian date:

{"type":"number"}

instead of a regular expression for an ISO 8601 time stamp:

{"type":"string","pattern":"^(?:[1-9][0-9]{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1[0-9]|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9][0-9](?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](?:Z|[+-][01][0-9]:[0-5][0-9])$"}

Note: Maybe the non-capturing groups have to be removed. The implementation I have used for the test, accepts it. It probably depends on the implementation.

JSON Schema to check date of YYYY-MM-DD

5 Answers5