Comment 5 for bug 1324142

It looks like, over time, a number of additional fields have crept into the JSON, most likely because scope authors and the shell have made gentlemen's agreements. This includes (at least), mascot, emblem, attributes, summary, background, and overlay-color. It also looks like there are result-specific settings (such as mascot) that are undocumented, and for which there is no accessor/setter in the Result or SearchResult classes.

We need to construct a definitive list of which fields are used by the shell, both per-category and per-result, so we can document them. Otherwise, all these features will remain inaccessible to outside scope authors.

As discussed with Saviq on IRC, he'll find someone who can construct this list by inspecting the shell code, so we can update the scopes documentation accordingly.

In future, whenever the shell interprets something new in the JSON, or changes the meaning of an existing entry, we'll need to raise a bug with scopes-api so we can update the doc.