-
Type:
Task
-
Resolution: Fixed
-
Priority:
Major - P3
-
Affects Version/s: None
-
Labels:None
If a document fails validation and JSON Schema is used in the validator, we will now include the "description" field as part of the error message. Users can now use "description" to include a human-friendly explanation of what the schema is intended to enforce.
Flagging documentation changes as potentially needed in case some examples in the docs need updating with this change.
Description of Linked Ticket
It would be nice to return the description that the user included in the JSON schema, as it may help understand the business logic behind the rule in cases where there's a complex regex or some other non-obvious restrictions.
Example:
{
"$jsonSchema": {
"bsonType": "object",
"properties": {
"localization": {
"bsonType": "object",
"additionalProperties": false,
"patternProperties": {
"^description_(es|de|fr)+$": {
"bsonType": "string"
}
},
"description": "Currently only Spanish, German and French are supported."
}
}
}
}
Error:
{
"propertyName": "localization",
"details": [
{
"operatorName": "additionalProperties",
"specifiedAs": {
"additionalProperties": false
},
"additionalProperties": ["description_cz"]
}
]
}
- documents
-
-
- Closed
-