Readme was little informative about data model. I attempt to make it more precise.
Readme stated that "name" and "position" are obligatory fields. However I have the impression that the application may rely on the fact that also other fields are present in all datapoints. For example "type_of_place" here:
https://github.com/Problematy/goodmap/blob/62c62a1c0ec952a5107bede349cd75ba8fd53882/goodmap/formatter.py#L16). \
I suggest introducing a new subsection obligatory_fields where you can explicitly define all such fields. This will allow the validation script to verify their presence in every datapoint.
In readme there was a paragraph of "custom data" and it mentioned something like "displayVaule". I don't know if it is necessary so I deleted it.
Readme was little informative about data model. I attempt to make it more precise.
Readme stated that "name" and "position" are obligatory fields. However I have the impression that the application may rely on the fact that also other fields are present in all datapoints. For example "type_of_place" here: https://github.com/Problematy/goodmap/blob/62c62a1c0ec952a5107bede349cd75ba8fd53882/goodmap/formatter.py#L16). \ I suggest introducing a new subsection
obligatory_fieldswhere you can explicitly define all such fields. This will allow the validation script to verify their presence in every datapoint.In readme there was a paragraph of "custom data" and it mentioned something like "displayVaule". I don't know if it is necessary so I deleted it.