fix(spec): format validation errors for nested parameters

[glowcloud]

Refs #9774

The array parameters should now get index of the value where the error is instead of the undefined propKey. We should also go recursively into the nested errors to get a proper error message.

With these changes, the validation errors for this example input:

should now show up as:

We might want to try formatting them differently, ex. a.b.c: <error_message> or a[b][c]: <error_message>

I was also wondering if (perhaps in a separate issue/PR) we should show the names of the parameters. These are the values we get from

swagger-ui/src/core/plugins/spec/selectors.js

Line 494 in 2dcc387

let paramValues = state.getIn(["meta", "paths", ...pathMethod, "parameters"], fromJS([]))

for the above example

{
  "query.secondParam.hash-440249344": {
    "value": "{\n  \"a\": {\n    \"a\": {\n      \"a\": \"string\",\n      \"b\": \"test\"\n    },\n    \"b\": 0\n  },\n  \"b\": 0\n}",
    "errors": [
      {
        "propKey": "a",
        "error": {
          "propKey": "a",
          "error": {
            "propKey": "b",
            "error": "Value must be a number"
          }
        }
      }
    ]
  },
  "query.param.hash-609835841": {
    "value": [
      "{\n  \"a\": \"string\",\n  \"b\": \n}"
    ],
    "errors": [
      {
        "index": 0,
        "error": "Parameter string value must be valid JSON"
      }
    ]
  }
}

If we got the names of the parameters from the keys, we could format the message as param: a: b: c: <error_message> so the actual place of the error would be visible in case if we have more than one parameter for the request.

[char0n]

As discussed we need to identify parameter name and use known convention for the path (lodash).

So given I have this error message returned from validation engine: Parameter string value must be valid JSON, here are the options we have to annotate the error message with parameter name and path:

Suffix form:

• "Parameter string value must be valid JSON - location: 'paramName', path: 'a[0].b.c'."
• "Parameter string value must be valid JSON. See 'paramName'['a[0].b.c'] for details."
• "Parameter string value must be valid JSON, as specified for 'paramName' at 'a[0].b.c'."

Prefix form:

• "Validation Error in 'paramName' ('a[0].b.c'): Parameter string value must be valid JSON."
• "'paramName' > 'a[0].b.c': Parameter string value must be valid JSON."
• "For 'paramName' at path 'a[0].b.c': parameter string value must be valid JSON."

[glowcloud]

With the new changes, the parameters should now be formatted as:

[char0n]

With the new changes, the parameters should now be formatted as:

New messages look good!

[char0n]

How about doing the following?

if (paramValues.length === 0) return result

[glowcloud]

Is this to make it more clear what's happening if we don't have these values?
If so, makes sense to me.

[char0n]

Is this to make it more clear what's happening if we don't have these values?

Well primary factor is performance here. This is not a memoized selector, which means it's executing always fully. We want to return as soon as we can to avoid logic of creating inner functions and performing the reductions as soon as possible.

[char0n]

Suggested change

	let paramValues = state.getIn(["meta", "paths", ...pathMethod, "parameters"], fromJS([]))
	const paramValues = state.getIn(["meta", "paths", ...pathMethod, "parameters"], fromJS([]))

[char0n]

LGTM! Nicely done. The logic of error extraction and formatting is complex but it's concentrated in single place which is great. I left two comments to consider before merging.