808635 - Design and document payload format for FHR v1

Status: RESOLVED FIXED

(Firefox Health Report Graveyard :: Client: Desktop, defect)

Comment 1

[Gregory Szorc [:gps]]

Documented things as they are currently implemented in the services docs Git repo: https://github.com/mozilla-services/docs/commit/1bb8c649820ef2a5730647aca68198e53f3a0cf4

This should eventually be live at http://docs.services.mozilla.com/.

I'm tempted to resolve this bug...

Comment 2

[Richard Newman [:rnewman]]

I'd like it to stay open until we've finished building the data providers for v1. That way we can ensure completeness.

Comment 3

[Gregory Szorc [:gps]]

I was thinking we could document each provider as part of implementing it.

Comment 4

[Mark Reid [:mreid]]

>+        "providers": {
>+          "app-info": {
>+            "app-info": {
>+              "name": "app-info",

This example has one too many levels of '"app-info": {' nesting

Comment 5

[Gregory Szorc [:gps]]

That example is pretty bad. Here, "app-info" is both the name of the provider and the name of the measurement. The measurement name is redundantly defined, yes.

The JSON may change once daily measurements are added. I'm going to work on that today.

Comment 6

[Gregory Szorc [:gps]]

The new hotness looks like http://gps.pastebin.mozilla.org/2037468. This is roughly what I plan on shipping.

Xavier: How does that look to you?

Comment 7

[Xavier Stevens [:xstevens]]

Gregory: Looks fine to us. Mark commented on bug 824528 about this but we want to make sure we include only extensions and plugins in the addons list. Including themes can cause inadvertent privacy exposure.

Comment 8

[Gregory Szorc [:gps]]

I'm calling this one done. File a new bug if you want more docs.