Error Path, Error Message, and Unlimited Max Errors

[paulcruse3]

Not sure if I should separate these issues, but I can if needed.

1. Error Message & Error Path
   The current structure for error response varies pretty widely dependent on the error. Is there anyway I can just get the key path that the error occurred and an error message? (like the python implementation of json-schema) If that's not possible, are there any docs on all the possible error response structures? Example:

/*schema being used*/
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "/API/V1/Login/schemas/post.json",
    "type" : "object",
    "properties" : {
        "email" : {
            "type" : "string",
            "format" : "email"
        },
        "password" : {
            "type": "string",
            "minLength": 6
        }
    },
    "required" : ["email", "password"],
    "additionalProperties" : false
}

/*bad request recieved*/
{
  "password": 1
}

/*library error response using all the available methods on ValidationError class*/
[
   {
      "pointer": [],
      "keyword": "required",
      "arguments": {
        "missing": "email"
      }
    },
    {
      "pointer": [
        "password"
      ],
      "keyword": "type",
      "arguments": {
        "expected": "string",
        "used": "integer"
      }
    }
]

/* python style implementation (what I am trying to get) 
ValidationError class has two more methods (getErrorPath(), getErrorMessage()) */
[
    {
      "path": "email",
      "message": "missing required field"
    },
    {
      "path": "password",
      "message": "type must be a `string`"
    }
]    

2. Unlimited Errors
   I see the default for $max_errors is set to 1; how can I set max errors to unlimited? I've tried to just not pass anything (it defaults to 1) and tried setting to null (it throws an error).

[sorinsarca]

1. Please see Error messages #16
2. You have to pass 0 or -1 for unlimited.

[paulcruse3]

Thanks, I'll be looking forward that that update...

On another note, does this package support $datatype const? I just want to write an account validation that requires the password and password_confirm match; I wrote something like this, but its not working:

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "/API/V1/Login/schemas/put.json",
    "type" : "object",
    "properties" : {
        "email" : {
            "type" : "string",
            "format" : "email"
        },
        "password" : {
            "type": "string",
            "minLength": 6
        },
        "password_confirm" : {
            "type": "string",
            "const": {
                "$data": "1/password"
            }
        }
    },
    "required" : ["email", "password", "password_confirm"],
    "additionalProperties" : false
}

[sorinsarca]

Issue #1 answers your questions (also includes the solution).

[jacobnijgh]

1. Please see Error messages #16
2. You have to pass 0 or -1 for unlimited.

-1 is what i needed to use for retrieving all the errors, this is not clearly stated in the docs btw,

[int $max_errors = 1] - maximum numbers of validation errors that can occur before data is considered invalid (and method returns)

[KodyWiremane]

I suggest adding ValidationError with:

• string $message as 1st argument to __construct, to pass an error message in plain English;
• protected $message to hold the message;
• public function errorString to retrieve the message;
• public function pointerString to get dataPointer as a string like '/path/2/offending/value';
• public function errorMessage to get a string like '/path/2/offending/value: Error message for it';
• public function errorMessageWithSubs to get errorMessage() from current ValidationError an its sub-errors, prefixed with error nesting levels:

[0] /root/offender: Message for a compound error
[1] /root/offender/1stBad: Message for this too
[1] /root/offender/2ndBad: And this one, and so on
[2] /root/offender/2ndBad/bonus: We need to go deeper

Accordingly, new ValidationError(…) calls in Validator.php are to be added with text messages. Developers (using opis/json-schema) need them anyways, so I think it's better to include the code into the library, than everyone inventing their own 'validationError2String'.

If y'all like, I can provide a commit.

[KodyWiremane]

Let me stir the discussion a little.

I also think that ValidationError needs easy-to-get strings for data pointers and error messages. Printing an error message is a natural reaction to an error, so why not integrate the common part into the library? Regardless of errors being returned in a flat or a nested structure, readable messages naturally fit in.

Should we expect any progress in this direction? @sorinsarca , please give us a sign 礼

[sorinsarca]

In v2.0 the class Opis\JsonSchema\Errors\ErrorFormatter contains helpers to get and format the error messages.