org.json_schema.contrib.generate1.1.4

Limitations:

• Cannot generate not, allOf, or anyOf combinators correctly due to limitations in Pkl's model.
  • Union types exist, but they are logically the same as oneOf (only one subschema can match).
  • Intersection types do not exist (can use this to model allOf).
• Doesn't generate correct types for schemas that use both JsonSchema.properties and JsonSchema.additionalProperties because classes cannot contain entries (known limitation, will be addressed in a future Pkl release). Some possible workarounds:
  • Add a child Mapping property to represent "additional properties" and add a renderer to inline them/
  • Add an option to the generator to control whether a class or a Mapping gets generated.
• Cannot generate JsonSchema.patternProperties fully (this is a limitation of Pkl). If there is just one pattern property, it gets generated as a Mapping. Otherwise, this falls back to Dynamic, which is the loosest constraint.
• Cannot generate tuple types (this is missing in Pkl).
• Properties called default cannot be generated (currently a limitation of the json parser).
• allOf schemas have several limitations
  • default will only be combined when all subschemas have the same value
  • deprecated will be true if an only if all subschemas have it set to true, otherwise it will be null
  • readOnly and writeOnly must be identical for all subschemas
  • type must be identical (or null) for all subschemas
  • const must be identical (or null) for all subschemas
  • if multiple subschemas set multipleOf, all must be integers
  • format must be identical (or null) for all subschemas
  • overlapping properties and patternProperties entries are merged as allOf according to these rules
  • fields that accept JsonSchema.Schema values must all be JsonSchema values (or null)
  • items must be JsonSchema or null, not Listing<JsonSchema>
  • there must be precise overlap between elements of oneOf and anyOf

TODO:

• Copy doc comments from a class or typealias to its usage sites if there isn't a doc comment already.
• Handle if schema root is not an object type (Example: ansible's schema root has "type": "array").
• Handle if schema root should be a mapping (it has additionalProperties or patternProperties set).

Sample CLI usage:

pkl eval package://pkg.pkl-lang.org/pkl-pantry/org.json_schema.contrib@<version>#/generate.pkl \
  -m . \
  -p source="https://json.schemastore.org/github-action.json"