From 7b432ffe7f19bb9aab2d120c0b8e6d49b8bb373c Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Fri, 7 Oct 2022 11:55:30 +0200 Subject: [PATCH] readme: describe generation rules --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 6bffcaf..77b9bd9 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,14 @@ A JSON schema code generator for Go. jsonschemagen -s -o +One Go type per definition will be generated. + +- `int64` is used for `"type": "integer"`. +- `json.Number` is used for `"type": "number"`. +- Go structs are generated for objects with `"additionalProperties": false`. +- `json.RawMessage` is used when a value can have multiple types. Helpers are + generated for `allOf`, `anyOf`, `oneOf` which are references. + ## License MIT