Compare module - detailed diff and summary diff views

[JulieRossi]

Implementing the option to display the full differences in the compare module, a choice needs to be made regarding the output format.

In the detailed diff, we'll have something like (potentially with more information like description, sensitive, etc.):

Hierarchy	Previous Schema	New Schema
borough	{"type": "string", "prop_in_object": 1.0, "count": 25359, "types_count": {"string": 25359}}	None
_borough	None	{"type": "string", "prop_in_object": 1.0, "count": 25359, "types_count": {"string": 25359}}
cuisine	{"type": "string"}	{"type": "ARRAY"}
grades.grade	{"type": "string", "prop_in_object": 3.6856, "count": 93463, "types_count": {"string": 93463}}	None

Currently, the summary view is like:

Hierarchy	Previous Schema	New Schema
	borough	None
	None	_borough
cuisine	{"type": "string"}	{"type": "ARRAY"}
grades	grade	None

Both views do not have the same hierarchy in the case of a missing / new field.

A solution would be to use the same hierarchy as the detailed view in the summary one, repeating the field name :

Hierarchy	Previous Schema	New Schema
borough	borough	None
_borough	None	_borough
cuisine	{"type": "string"}	{"type": "ARRAY"}
grades.grade	grade	None

What do you think about this solution ? Does it seem clear to you ?

Another possibility would be to give more details about the missing / new field in the schema columns.

But this might be confusing.

• Either we choose to display the whole field data (instead of just its name) but this makes the summary view not no short (especially in case of nested fields or at collection level)
• or we choose to show only some information about the field (maybe just the type). In this case, one might think the information in the schema column represent actually the whole field value.

@pajachiet , @aureliengervasi which of these three solutions (or maybe another one) would you choose ?

[aureliengervasi]

Hi Julie,

I just want to understand : having 2 different hierarchies between the detailed and summary view is a technical issue for you (= difficult to implement) ? Or is it a layout issue (= difficult to understand) ?

In the first case, I would indeed prefere the first solution you suggest, limiting the amount of information given in the summary view.

[JulieRossi]

It was more a layout issue (it needs a little more code too but I don't see it as a problem if the result is better)

[aureliengervasi]

Let's go then for now with repeating the field name in the hierarchy column and the schema column (your first solution). We can make the code evolve later if need be.