GSoD: How to Write a JSON Schema Implementation (... Using Bowtie)

[Julian]

Project title

How to Write a JSON Schema Implementation Using Bowtie

Brief Description

Imagine you're someone who wants to create a new JSON Schema implementation -- a tool for someone, in some programming language, to use to validate JSON Schemas against their data.

The JSON Schema test suite is an amazing resource you can use to build up your new tool. It contains a library of tests with "known correct results" which you can use to help you implement correct behavior. The recent Bowtie tool can be used to interact with the suite if you integrate with it.

Let's show how to do so for a completely new implementation in a hands-on tutorial taking someone through the path they might take. Here's an example of how such a tutorial might be structured:

• Writing a Bowtie Harness, even though you don't have any code yet -- to see all the tests fail but run!
• Picking how to structure your new implementation's API for validating
• Picking which JSON Schema keywords to start with
• Passing your first tests for that keyword via Bowtie
• Making a mistake in your API and having to rework it
• Supporting multiple versions of JSON Schema
• ...

Expected Outcomes

The main deliverable here is a tutorial, rather than the implementation itself, though you may of course also publish the implementation!

Skills Required

Good knowledge of a programming language of your choice
Great writing skills, and maybe some previous time you wrote a post or tutorial for others to follow

Mentors

@Julian

Expected Difficulty
Medium

Expected Time Commitment
350 hour

[benjagm]

Hi Julian, this seems to be a documentation idea. Are you ok if we keep this one for Google Season of Docs? It is great you detailed this idea so well because this is exactly what I had in mind for release 6 of our documentation strategy: json-schema-org/website#158

[Julian]

Great! Yeah all fine, agree it fits more with docs, I put this one in yesterday just because it randomly came to mind as I was otherwise distracted, will add a few more.

[DhairyaMajmudar]

Hi, @Julian @benjagm I would like to perform this task under GSoD, attaching my proposal PR in the GSoD repo. google/season-of-docs#1199