Rethink JSON Schema generation

[ddbeck]

ts-json-schema-generator only incompletely generates a schema based on our TypeScript types. It seems to have some longstanding bugs around keyof. I doubt they'll be fixed any time soon.

We should explore alternatives for keeping our TypeScript types and JSON Schema in sync.

Some routes we might consider:

• Use a different method to generate JSON Schemas (e.g., describe the types with zod and use zod-to-json-schema)
• Author JSON Schema directly and generate TypesScript types (e.g., json-schema-to-typescript)

[jcscottiii]

Author JSON Schema directly and generate TypesScript types

If you're open to it, I would vote for this approach. I will also suggest another tool named quicktype. It supports multiple languages (including typescript). If you want to try it out, you could paste the JSON schema into their online tool and change the source type to JSON Schema and change the language to typescript. (They also have Typescript Zod too)

---

webstatus.dev uses it on the data.schema.json here to generate the Go types. A few things to note:

• It gets a little confused on the fields that are either or 1) a single string or 2) array of strings when using their Go generator. (Let me know if you want more details. Or you can try the Go generator on their online tool)
  • Unrelated question: Would you be open to switching to just an array of strings in the next major version of the schema? If not, that's okay.

As a result, webstatus.dev keeps a slightly modified version of the schema in the tree [1].

After making that modification, it works great!

[ddbeck]

Thank you for the quicktype recommendation, @jcscottiii! I much prefer the idea of using a tool that someone has first hand experience with.

[ddbeck]

And #1981 (comment) covers making the types consistent for arrays of strings. It is planned for the next major release.