Add the file formats to the README.md file #27
Conversation
|
Awesome, seems pretty clear to me :) I have a few inline comments. |
| "history": { | ||
| "<channel>": [ | ||
| { | ||
| "cpp_guard": <string or null>, |
There was a problem hiding this comment.
Could we get a description of this field?
There was a problem hiding this comment.
Good catch! This probe data comes directly from the Telemetry probe definition. I've added a note at the bottom of this section with a link to the Telemetry docs with the full documentation on all the fields that can be found there.
| "optout": true, | ||
| "revisions": { | ||
| "first": "320642944e42a889db13c6c55b404e32319d4de6", | ||
| "last": "6f5fac320fcb6625603fa8a744ffa8523f8b3d71" |
There was a problem hiding this comment.
Now that I see an example entry, I'm a bit concerned about ease of getting "probes active in the current latest release in each channel", which is a pretty common pattern
There was a problem hiding this comment.
The probe dictionary does this by getting all the probes for all the channels and then filtering for revision.first == <current revision>. I think we can probably make it better though: do you want to file another issue on this repo?
This additionally removes the empty README file.
|
Let me go ahead and merge this, since this is just a doc update. Feel free to open another issue about changing the API if needed, @sunahsuh ! |
This additionally removes the empty README file. This should land, ideally, after #25 gets merged.