Skip to content

Commit 606ce17

Browse files
docs: Re (#156)
* docs: Should we recommend a tool? Many people haven't generated schemas before or don't want to write by hand. Should we recommned a tool to make the process faster? * style(lint): Auto commit lint changes --------- Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>
1 parent d288a50 commit 606ce17

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Currently only jsonschema is supported. The jsonschema should be placed directly
88

99
We use jsonschema for both JSON- and msgpack-based topics, as most msgpack types have a JSON-equivalent. For bytestrings, we type them using `{"description": "msgpack bytes"}`, which is currently just interpreted like `{}` (allow all types).
1010

11+
If you don't want to hand-write it, for generating an initial json schema from a payload we like https://github.com/quicktype/quicktype
12+
1113
## How strict should my schema be?
1214

1315
If in doubt, we recommend that schemas are only as strict as is minimally required by all consumers and downstream code required by Sentry. However it is ultimately up to the owners of the schema to decide whether a stricter schema is appropriate in particular scenarios.

0 commit comments

Comments
 (0)