rwmt / modlist-consultant Goto Github PK

The front end displayed compatibility codes are not semantically sufficient for end users to understand their meaning. All uses of the compatibility codes in the template should be replaced with parsed semantic strings.

Compatibility code meanings and type inferences should also be removed from source code to future proof the tool.

Semantic meanings should be parsed from cell A2 of the spreadsheet. This cell provides the following format:

• Compatibility codes are line separated
• Each line begins with a code and its semantic meaning, separated by and equals (=) sign
• Codes and their meaning should have leading and trailing whitespace trimmed

This will require a breaking change to the response format, or a secondary GET request to retrieve the legend. Since it is unlikely that there are other clients consuming the API at this moment, it is recommended to break the current format and make it more future friendly.