Document full JSON format for alerts |
||||
Issue descriptionMaybe in the README? I've been testing SoM locally by just directly sending JSON for alerts to the client.So far alerts-data.js in the test directory has been a useful reference for formatting the JSON, but it's missing some stuff like FindIt results. I feel like it would be a good idea to note the exact JSON format used for the frontend and maybe edit this each time we need to edit the alert JSON format.
,
Aug 29 2016
Should we put it in the README, or in the go source? It (should) be decently documented there; see https://cs.chromium.org/chromium/infra/go/src/infra/monitoring/messages/alerts.go?q=alerts.go&sq=package:chromium&l=82 We can improve it there, and then we don't have two sources of truth :)
,
Aug 29 2016
It could potentially get quite lengthy (with example json blobs etc), so a separate README might be better. But having it close to alerts.go would be good, especially once the gae app starts using alerts.go to parse the json.
,
Sep 1 2016
,
Oct 5 2016
,
Feb 18 2017
I think this is probably not really necessary because yeah, it'd just be another thing to update. |
||||
►
Sign in to add a comment |
||||
Comment 1 by seanmccullough@google.com
, Aug 29 2016