key-value assertion example for JSON/YAML files is unclear

[TCLamnidis]

https://www.nf-test.com/docs/assertions/files/#json-files

The example provided in these sections of the page for assessing individual keys could be a bit clearer imo.

assert path(process.out.out_ch.get(0)).json.key == "value"

It should be made a bit clearer that this command tests that a key named key has a value of "value", and NOT that the list of keys in the JSON has only one element that is "value".
From the original example I was expecting path(process.out.out_ch.get(0)).json.key to return something like [ "metadata", "metrics" ] for my JSON that looked like { "metadata" : [...], "metrics" : [...] }.
i.e. the current phrasing made it look to me like .key is like python's .keys().

Maybe the examples could be updated to something a bit more explicit like:

assert path(process.out.out_ch.get(0)).json.tool == "nf-test"

[Kah2412]

"Hi @TCLamnidis!

I'm a Software Engineering student and I completely agree with your suggestion. For those of us who are just starting out, using generic terms like 'key' and 'value' in documentation can be quite confusing.

Your proposed example json.tool == 'nf-test' is much more intuitive and makes it clear that we are asserting a specific property. I would love to help update these examples in the documentation to make it more newcomer-friendly!"