note on JTD error objects

ajv-validator · Feb 10, 2021 · 078d6a8 · 078d6a8
1 parent 9e5f247
commit 078d6a8
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -428,6 +428,8 @@ interface JTDErrorObject {
 
 This error format is used when using JTD schemas. To simplify usage, you may still generate Ajv error objects using `ajvErrors` option. You can also add a human-readable error message to error objects using option `messages`.
 
+**Please note**: Ajv is not fully consistent with JTD regarding the error objects in some scenarios - it will be consistent by  the time Ajv version 8 is released. Therefore it is not recommended yet to use error objects for any advanced application logic.
+
 ### Error parameters
 
 Properties of `params` object in errors depend on the keyword that failed validation.