OpenWPM Consider using JSON Schemas to document the instrumentation output

JSON Schemas allow us to specify every field in our output with a description and a set of constraints that allow verification and deserialization in many different languages including python. It also supports reuse so common parts of the structure would only need to be defined in one place.

Mar 10 '20 12:03 vringar

Hi... I am Akhila, Outreachy applicant for March 2020. May I start working on this? Is this still open for contribution? @vringar I am new to open source community. However, I am familiar with both JSON objects and Python programming language. Can you please guide me on getting up to speed with this issue?

Thanks

Mar 11 '20 13:03 Akhila499

Hey Akhila, While the issue is open and unassigned, I am unsure if this is a good issue to start on, as it requires quite a deep understanding of OpenWPM as a whole. I'll spent the next hours looking through our current issues and seeing if they would be good first issues.

Mar 11 '20 14:03 vringar

@birdsarah this is the issue I wanted your input on. Do you know if we could generate documentation from the schema. Because I don't want to assume that users could read JSON schema in it's raw form

Mar 13 '20 17:03 vringar

https://github.com/lbovet/docson

Mar 14 '20 01:03 birdsarah